PlagiarismSearch API: Frågor och Svar

API PS

API (Application Programming Interface) är en uppsättning rutiner, protokoll och verktyg för att bygga mjukvaruapplikationer. Den är skapad för att hjälpa organisationer att kontrollera stora mängder text genom sitt system. Vår API ger kunder en unik möjlighet att integrera vår mjukvara i sina egna system för att göra plagiatkontrollen till en automatiserad process. Eftersom API-integrationen kräver specifik kunskap och vanligtvis utförs av tekniska specialister, uppstår många frågor om dess specifika funktioner för att säkerställa effektiv drift. I denna artikel har vi samlat de mest populära frågorna och svaren om vår API-prestanda samt lösningar på de vanligaste problemen våra kunder möter under integrationsprocessen.

Dessutom ger API-integrationen våra kunder möjlighet att använda det personliga lagringsutrymmet. Kunder kan ladda upp sina egna arkiv till lagringssystemet och spara texter som kontrollerats för plagiat via vår API, vilket skapar ett individuellt lagringsutrymme. Att kontrollera texter mot det personliga lagringsutrymmet gör det möjligt för våra kunder att upptäcka och förhindra självplagiat. Läs mer om funktionerna i det personliga lagret i vår guide https://plagiarismsearch.com/plagiarism-database.

Vilka funktioner finns tillgängliga via API?

Kontroll av texter och dokument för plagiat
Åtkomst till plagiatrapporter (historik över plagiatkontroller)
Möjlighet att ladda upp kundens databas till lagringen och visa dokument i lagret
Återförsäljare har möjlighet att skapa flera användarkonton och tilldela dem ett lämpligt antal inskick/ord. Dessa alternativ ger varje hänvisning möjlighet att använda sitt konto självständigt.

Hur får jag åtkomst till API?

Du kan få tillgång till vårt API gratis i 30 dagar. Du får också 100 inskick och personligt lagringsutrymme för att testa alla fördelar med vår tjänst. Vänligen registrera dig via denna länk för att få tillgång till gratis API: https://plagiarismsearch.com/account/signup?from=%2Faccount%2Fapi

Efter registrering, gå till Min profil - API-inställningar, där du ser API-användare och nyckel som är personligt tilldelade dig. Du behöver även använda vår API-dokumentation (klicka på API-dokumentation i din profil https://plagiarismsearch.com/docs/ för att se den). Ge åtkomst till denna information till din tekniska specialist för att börja använda vår API.

Hur fungerar API:et för plagiatkontroll?

Vår API-funktionsschema är följande:

Användaren skapar en rapport (genom att skicka in text, ladda upp fil eller en offentlig URL) https://plagiarismsearch.com/docs/v3/reports/create
Om ditt saldo är aktivt – läggs dokumentet till för kontroll
Om du kontrollerar 1000–3000 ord samtidigt kan det ta 30–60 sekunder; fler ord tar något längre tid
Efter att dokumentet har kontrollerats får användaren en `callback_url` POST-förfrågan https://plagiarismsearch.com/docs/v3/reports/callback-request
Exempel på API-användning i PHP https://plagiarismsearch.com/files/sample-api.zip

Utför API:et automatisk textverifiering i realtid?

Ja, plagiatkontrollen utförs i realtid. Det tar 1–5 minuter att kontrollera en text, och tiden beror på textens storlek.

Är det möjligt att förbereda och ladda ner rapporter via API?

Ja, du kan ladda ner PDF- eller HTML-rapporter direkt efter att plagiatkontrollen är slutförd. Alla rapporter lagras i vår databas, så du kan komma åt dem när som helst och ladda ner https://plagiarismsearch.com/docs/v3/reports/view

Är det möjligt att skapa en egen rapportmall?

Nej. Vi har 2 tillgängliga rapportmallar. Du kan endast infoga ditt företags logotyp i vår rapportmall.

Stöder API:et verifiering av specifika delar av texten?

Ja, om du syftar på att inkludera eller exkludera referenser eller citat samt vitlista specifika URL:er.

Är det möjligt att se historiken för textkontroller via API?

Ja, alla rapporter sparas i din databas.

Är det REST API eller plugin? Är det synkront eller asynkront?

Vi tillhandahåller RESTful API. Tillgång till vår API-dokumentation finns här: https://plagiarismsearch.com/docs/

Vår API är asynkron. När plagiatkontrollen är klar skickar vi en webhook till användarens callback_url (https://plagiarismsearch.com/docs/v3/reports/callback-request).

Finns det instruktioner för hur man implementerar API?

En mer detaljerad implementationsplan för API är följande:

Registrera dig på vår webbplats här https://plagiarismsearch.com/se/account/signup
Se till att ditt saldo är aktivt eller anmäl dig till gratis API-test https://plagiarismsearch.com/account/signup?from=%2Faccount%2Fapi
Gå till Min profil - API-inställningar, där du ser API-användare och nyckel personligt tilldelad dig https://plagiarismsearch.com/se/account/api
Skicka en fil eller text för plagiatkontroll med hjälp av HTTP grundläggande autentisering https://plagiarismsearch.com/docs/v3/reports/create. Här är ett exempel i CURL:
curl_setopt($curl, CURLOPT_USERPWD, $apiUser . ':' . $apiKey);
Du får ett svar med rapport-ID:
"data": { "id": 100500, "auth_key": "65jdgjhh7h452hjkh45k7535", ... }
Vår detektionsmotor startar plagiatkontrollprocessen.
När plagiatkontrollen är avslutad, skickar systemet POST-webhook till URL:en som är kopplad till det inskickade dokumentet. Om ingen URL angavs, skickas webhooken till URL:en kopplad till användarkontot.
Det finns ett alternativt sätt att ställa in statusen för plagiatkontrollen, även om det inte rekommenderas av vårt team. Det är att övervaka rapportstatusen https://plagiarismsearch.com/docs/v3/reports/status med vissa tidsintervaller och kontrollera om statusen är “Finished” (status=2), “Error” (status=-10), eller “Serverfel” (status=-11)
När plagiatkontrollen är avslutad, kan du få detaljerad information med rapport-ID. Ett exempel finns här: https://plagiarismsearch.com/docs/v3/reports/view

Du kan dessutom specificera parametern `show_relations` för att få mer data.

Exempelvis:
const RELATIONS_SOURCES = -2; const RELATIONS_RAW = -1; const RELATIONS_NONE = 0; // standard const RELATIONS_TREE = 1;

show_relations = -2 => returnerar lista över källor sorterade efter plagiatprocent. Se `data.sources` svarsfält
show_relations = -1 => returnerar all rapportdata. Stycken, meningar och källor med markerad text. Se `data.paragraphs` svarsfält
show_relations = 1 => returnerar all rapportdata. Stycken, meningar och källor med markerad text. Se `data.paragraphs` svarsfält

Måste skript vänta på resultatet av plagiatkontrollen eller finns det en callback-funktion som kan användas senare för att hämta resultatet?

Det finns en callback-hook POST URL-förfrågan som vi kopplar till användaren. Du kan även ange din (anpassade) callback_url i inställningarna när du skickar in dokumentet ( https://plagiarismsearch.com/docs/v3/reports/create, https://plagiarismsearch.com/docs/v3/reports/callback-request)

Rapporten kan laddas ner i flera format: (https://plagiarismsearch.com/docs/v3/reports/view) (Se "Response")

{
   "status": true,
   "code": 200,
   "data": {
      "file": "https://plagiarismsearch.com/reports/download/100500?key=54fba6bc7d765cab653f2185a83284a6", // offentlig pdf-rapport URL
      "link": "https://plagiarismsearch.com/reports/100500?key=54fba6bc7d765cab653f2185a83284a6", // offentlig html-rapport URL
      "files": [
        {
            // offentlig EN pdf-rapport URL version 3
            "url": "https://plagiarismsearch.com/r/download100500?key=54fba6bc7d765cab653f2185a83284a6",
            "type": "application/pdf",
            "language": "en",
            "version": 3
         },
         { // offentlig ES pdf-rapport URL version 3
            "url": "https://plagiarismsearch.com/es/r/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
            "type": "application/pdf",
            "language": "es",
            "version": 3
         },
         { // offentlig PL pdf-rapport URL version 3
            "url": "https://plagiarismsearch.com/pl/r/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
            "type": "application/pdf",
            "language": "pl",
            "version": 3
         },
         { // offentlig EN pdf-rapport URL version 1 (nuvarande)
            "url": "https://plagiarismsearch.com/reports/download/100500?key=54fba6bc7d765cab653f2185a83284a6",
            "type": "application/pdf",
            "language": "en",
            "version": 1
         }
      ]
   }
}

Hur får jag en HTML-rapport?

För att få en HTML-rapportlänk behöver du skicka en GET-förfrågan till https://plagiarismsearch.com/api/v3/reports/{id} där {id} är rapport-ID:t du vill hämta en rapport för. I “Svar” hittar du rapportlänken i fältet `data.link`. Dessutom, i “Svar” hittar du ‘data.auth_key’ som du kan använda för att generera 3 möjliga varianter av HTML-rapporter.

Till exempel finns det 3 möjliga varianter av HTML-rapporter för data.auth_key=65jdgjhh7h452hjkh45k7535

https://plagiarismsearch.com/reports/100500?key=65jdgjhh7h452hjkh45k7535
https://plagiarismsearch.com/r/100500?key=65jdgjhh7h452hjkh45k7535
https://plagiarismsearch.com/reports/lite/100500?key=65jdgjhh7h452hjkh45k7535

Dessutom kan du generera rapportlänkar på 4 olika språk (EN, ES, PL, RU)

https://plagiarismsearch.com/reports/100500?key=65jdgjhh7h452hjkh45k7535
https://plagiarismsearch.com/es/reports/100500?key=65jdgjhh7h452hjkh45k7535
https://plagiarismsearch.com/pl/reports/100500?key=65jdgjhh7h452hjkh45k7535
https://plagiarismsearch.com/ru/reports/100500?key=65jdgjhh7h452hjkh45k7535

Du kan fritt kombinera olika varianter av HTML-rapporter och språk för att få den rapporttyp du behöver på valt språk.

Samma schema kan användas för att generera PDF-rapportlänkar (dessa URL:er kan ses i “Svar” -> `data.files`).

Till exempel:

...
"files":[
   {
      "url":"https://plagiarismsearch.com/r/download/100500?key=65jdgjhh7h452hjkh45k7535",
      "type":"application/pdf",
      "language":"en",
      "version":3
   },
   {
      "url":"https://plagiarismsearch.com/es/r/download/100500?key=65jdgjhh7h452hjkh45k7535",
      "type":"application/pdf",
      "language":"es",
      "version":3
   }
]
...

Jag kan inte hitta endpoints/detaljer om hur man genererar åtkomsttoken.

Token kommer att finnas i ditt konto efter registrering (https://plagiarismsearch.com/se/account/api)

Det är nödvändigt att skicka den med HTTP Basic Authentication.

Php med CURL
// HTTP basic authentication curl_setopt($curl, CURLOPT_USERPWD, $apiUser . ':' . $apiKey);

Jag vill bifoga filer i DOCX, PDF och PPT för kontroll. Är det möjligt?

Du kan bifoga filer i flera format: (https://plagiarismsearch.com/docs/v3/reports/create) filsträng eller ladda upp fil för kontroll.
Dessutom kan du skicka filer med namnet `file`

Till exempel:
curl -F 'file=@/home/petehouston/hello.txt' https://plagiarismsearch.com/api/v3/reports/create

Hur får jag listan över URL:er där texten hittades?

Du måste använda show_relations=1 eller om du bara behöver källor (länkar => procent plagiat) eller anropa route (POST-metod) https://plagiarismsearch.com/api/v3/reports/sources/{reportId} (inte dokumenterad än) och använda fältet `data.sources`

Hur kan jag exkludera min URL från listan?

Du kan anropa route (POST-metod) https://plagiarismsearch.com/api/v3/reports/skip/{reportId} (inte dokumenterad än) efter rapportkontrollen med POST-parametrar

a) POST['url'] = 'https://wikipedia.org' eller

b) POST['source'] = {source.id} (t.ex. data.sources[0].id (heltal)) eller

c) array av uteslutna URL:er
POST['urls'][] = 'https://wikipedia.org'
POST['urls'][] = 'https://plagiarismsearch.com'

array av uteslutna käll-ID:n
POST['sources'][] = {source.id}
POST['sources'][] = {source.id2}

Om du anropar route två gånger kommer URL:er att inkluderas igen och påverka den totala plagiatprocenten

För tydligare användning är det bättre att använda routes med samma parametrar som beskrivits ovan.
https://plagiarismsearch.com/api/v3/reports/exclude/{reportId} https://plagiarismsearch.com/api/v3/reports/include/{reportId}

Vi planerar också att komplettera en funktion för att tillåta uteslutning av URL här: https://plagiarismsearch.com/api/v3/reports/create

Hur kan jag räkna om plagiatprocent efter uteslutning?

Svaret på förfrågan kommer att inkludera den generella (ändrade) plagiatprocenten i data.plagiat

Vad är "filter_references" & "filter_quotes" bra för?

filter_references=1 => uteslut referenser. Referenstexten påverkar inte total plagiatprocent

filter_quotes=1 => uteslut citat i texten. Citattexten påverkar inte total plagiatprocent. Citatmarkörer är

array('«', '»'), array('"', '"'), array('“', '”'), array('《', '》'), array('〈', '〉'), array('{*', '*}'),

Finns det ett sätt att använda API via CURL?

Här är riktlinjer som kan förenkla din CURL-implementation.

Ladda upp dokument för plagiatkontroll https://plagiarismsearch.com/docs/v3/reports/create
curl --location --request POST 'https://plagiarismsearch.com/api/v3/reports/create' \ --header 'Authorization: Basic your_user_key_combination==' \ --form 'search_web="1"' \ --form 'search_storage="1"' \ --form 'file=@"test_file_plagiarism.txt"'
Visa rapport https://plagiarismsearch.com/docs/v3/reports/view
curl --location --request GET 'https://plagiarismsearch.com/api/v3/reports/3520470' \ --header 'Authorization: Basic your_user_key_combination=='

curl 1

Varför har dokumentet status “Pending” i lagringen?

Dokumentet är vanligtvis i Pending-status inte särskilt länge, från 0 till 6 minuter efter uppladdning eller ominladdning. Dokumentet läggs omedelbart till i sökindexet.

Du kan även kontrollera detta i programmets kod: om 6 minuter har passerat, har dokumentet status Active.

Det går att ta reda på dokumentstatus med denna metod:

GET https://plagiarismsearch.com/api/v3/storage/{id}
Se fältet `data.is_in_index`

Hur laddar jag upp dokument till lagringen via API?

Du kan ladda upp dokument via API:

POST https://plagiarismsearch.com/api/v3/storage/create
med parametrar liknande de på https://plagiarismsearch.com/docs/v3/reports/create

Ladda upp till lagring

Alternativt kan du ladda upp dokument i lista eller arkiv med formuläret https://plagiarismsearch.com/storage/upload

Vilka möjligheter har ett återförsäljarkonto? Hur integrerar jag det i mitt eget system?

Funktionerna som erbjuds av vårt återförsäljarkonto är:

Varje ny användare måste skapas via API:et (du behöver inloggning och lösenord för att skapa varje användarkonto)
Du kommer att ha möjlighet att tilldela ett visst antal ord till varje användare via återförsäljarens konto.

Dessa alternativ ger möjlighet för varje kund att använda sitt konto självständigt, och du kommer att kunna lägga till ord som behövs för varje användare

Teknisk dokumentation som krävs för integration:

Du behöver ha ett återförsäljarkonto för att kunna skapa kunder. Kontakta oss på services@plagiarismsearch.com för att få tillgång till fulla möjligheter för ett återförsäljar konto.

Skapa kund

För att skapa en ny kund, skicka en POST-förfrågan https://plagiarismsearch.com/api/v3/reseller-customers/create (Kundens e-post är ett obligatoriskt fält)

Till exempel:
curl --location --request POST 'https://plagiarismsearch.com/api/v3/reseller-customers/create' \
--header 'Authorization: Basic
din_användarnyckel_kombination===' \
--form 'email="testusermail@gmail.com"' \
--form 'name="User Name"' \
--form 'password="123456"'

Svar

{
   "status":true,
   "code":200,
   "data":{
      "id":26784,
      "email":"testusermail@gmail.com",
      "name":"User Name",
      "status":"active",
      "password":"123456"
   },
   "version":"3.0.0"
}

Lista över kunder

Skicka en GET-förfrågan 'https://plagiarismsearch.com/api/v3/reseller-customers' för att få listan över alla kunder som skapats.

Till exempel:
curl --location --request GET 'https://plagiarismsearch.com/api/v3/reseller-customers' \ --header 'Authorization: Basic din_användarnyckel_kombination=='

Visa saldon

Skicka en GET-förfrågan https://plagiarismsearch.com/api/v3/reseller-customers/balance för att visa ditt saldo.

Hämta ditt saldo

Skicka en GET-förfrågan https://plagiarismsearch.com/api/v3/reseller-customers/balance/{userId} för att visa saldot för en specifik kund.

Exempel på svar för saldo:

{
   "status":true,
   "code":200,
   "data":{
      "is_solvable":true,
      "700":{
         "type":"Words",
         "amount":6001,
         "expired":1878542044,
         "is_valid":true,
         "is_solvable":true
      },
      "300":{
         "type":"Submissions",
         "amount":4,
         "expired":1720878480,
         "is_valid":true,
         "is_solvable":true
      }
   },
   "version":"3.0.0"
}

Betala till kundens saldo

Lägg till nödvändigt antal inskickningar eller ord till ett specifikt kundkonto genom att ange användar-ID och belopp i fälten `words` eller `submissions` (1 inskickning = 1000 ord).

Till exempel:
curl --location --request POST 'https://plagiarismsearch.com/api/v3/reseller-customers/pay/26784' \ --header 'Authorization: Basic din_användarnyckel_kombination==' \ --form 'words="1000"'

{
   "status":true,
   "code":200,
   "data":{
      "payment_id":1171,
      "amount":100,
      "type":"Words"
   },
   "version":"3.0.0"
}

Hur man åtgärdar fel: 400 Bad Request vid inskickning av text för plagiering?

Exempel på fel du kan få när du skickar text för plagiering kan se ut så här:

Request Method: PUT
Status Code: 400 Bad Request

Svar: Inga instanser tillgängliga för plagiarismsearch.com

Plagiat-API som används: https://plagiarismsearch.com/api/v3/reports/create

Lösning:

Kunden bör använda POST HTTP-metod (inte PUT) som i skärmdumpen

400 Bad Request

Det finns ett autentiseringsfel när jag kör /report med GET via request-modulen i Python.

Du måste skicka autentiseringsdata vid varje ny förfrågan.

Vi använder Basic Authentication, såsom< https://docs.python-requests.org/en/master/user/authentication/
from requests.auth import HTTPBasicAuth >>> requests.get(' https://plagiarismsearch.com/api/v3/reports/{id}', auth=HTTPBasicAuth('apiUser', 'apiKey')) // HTTP basic authentication Php using CURL curl_setopt($curl, CURLOPT_USERPWD, $apiUser . ':' . $apiKey);