API PlagiarismSearch: Întrebări și Răspunsuri

API PS

API (Interfața de programare a aplicațiilor) este un set de rutine, protocoale și instrumente pentru construirea aplicațiilor software. A fost creat pentru a ajuta organizațiile să verifice cantități mari de text prin sistemul lor. API-ul nostru oferă clienților oportunitatea unică de a integra software-ul nostru în propriile lor sisteme pentru a face procesul de verificare a plagiatului un proces automatizat. Deoarece integrarea API necesită cunoștințe specifice și este de obicei realizată de specialiști tehnici, apar multe întrebări despre caracteristicile sale particulare pentru a asigura o funcționare eficientă. În acest articol, am adunat cele mai populare întrebări și răspunsuri despre performanța API-ului nostru și soluțiile pentru cele mai frecvente probleme cu care se confruntă clienții noștri în timpul procesului de integrare.

În plus, integrarea API le oferă clienților noștri posibilitatea de a profita de Stocarea personală. Clienții pot încărca propriile arhive în sistemul de stocare și salva textele verificate pentru plagiat prin API-ul nostru, creând astfel un Stocaj individual. Verificarea textelor pentru plagiat împotriva Stocării personale le permite clienților noștri să detecteze și să prevină auto-plagiatul. Citiți mai multe despre funcționalitățile stocării personale în ghidul nostru https://plagiarismsearch.com/ro/plagiarism-database.

Ce funcționalități sunt disponibile prin API?

Verificarea textelor și documentelor pentru plagiat
Acces la rapoartele de plagiat (istoricul verificărilor de plagiat)
Posibilitatea de a încărca baza de date a clientului în stocare și de a vizualiza documentele din stocare
Distribuitorii au posibilitatea de a crea mai multe conturi de utilizator și de a le atribui un număr corespunzător de trimitere/cuvinte. Aceste opțiuni vor oferi posibilitatea ca fiecare recomandare să își folosească contul independent.

Cum pot obține acces la API?

Puteți avea acces la API-ul nostru gratuit timp de 30 de zile. Veți avea, de asemenea, 100 de trimitere și Stocare personală pentru a testa toate beneficiile serviciului nostru. Vă rugăm să vă înregistrați folosind acest link pentru a primi acces la API-ul gratuit: https://plagiarismsearch.com/ro/account/signup?from=%2Faccount%2Fapi

După ce vă înregistrați, mergeți la Profilul meu - Setări API, și veți vedea Utilizatorul API și Cheia furnizată personal pentru utilizarea dumneavoastră. De asemenea, va trebui să folosiți documentația noastră API (faceți clic pe secțiunea Documentație API https://plagiarismsearch.com/docs/ în Profilul dumneavoastră pentru a o vizualiza). Oferiți acces la informațiile de mai sus specialistului dumneavoastră tehnic pentru a începe utilizarea API-ului nostru.

Cum funcționează API-ul de verificare a plagiatului?

Schema de operare a API-ului nostru este următoarea:

Utilizatorul creează un raport (prin trimiterea unui text, încărcarea unui fișier sau a unei adrese URL publice) https://plagiarismsearch.com/docs/v3/reports/create
Dacă soldul este activ – documentul dumneavoastră este adăugat pentru verificare
Dacă verificați între 1000-3000 de cuvinte deodată, poate dura 30-60 de secunde; mai multe cuvinte necesită un timp puțin mai lung
După verificarea documentului, utilizatorul primește o solicitare POST `callback_url` https://plagiarismsearch.com/docs/v3/reports/callback-request
Exemplu de utilizare a API în PHP https://plagiarismsearch.com/files/sample-api.zip

Asigură API-ul verificarea automată a textului în timp real?

Da, procesul de verificare a plagiatului se efectuează în timp real. Verificarea unui text durează între 1 și 5 minute, timpul de verificare depinzând de dimensiunea textului.

Este posibil să pregătiți și să descărcați rapoarte prin API?

Da, poți descărca raportul PDF sau HTML imediat după finalizarea verificării plagiatului. Toate rapoartele sunt stocate în baza noastră de date, astfel încât le poți accesa oricând și le poți descărca https://plagiarismsearch.com/docs/v3/reports/view

Este posibil să creez propriul meu șablon de raport?

Nu. Avem 2 șabloane de raport disponibile. Poți doar să inserezi sigla companiei tale în șablonul nostru de raport.

Permite API-ul verificarea unor părți specifice ale textului?

Da, dacă te referi la includerea sau excluderea referințelor sau citatelor, sau la includerea anumitor URL-uri.

Este posibil să vizualizezi istoricul verificărilor textului prin API?

Da, toate rapoartele sunt salvate în baza ta de date.

Este API-ul REST sau plugin? Este sincron sau asincron?

Oferim API RESTful. Accesul la documentația noastră API este aici: https://plagiarismsearch.com/docs/

API-ul nostru este asincron. Când verificarea plagiatului este finalizată, trimitem un web_hook la callback_url-ul utilizatorului (https://plagiarismsearch.com/docs/v3/reports/callback-request).

Există instrucțiuni despre cum să implementezi API-ul?

Un exemplu mai detaliat de implementare a API-ului este următorul:

Înregistrează-te pe site-ul nostru aici https://plagiarismsearch.com/ro/account/signup
Asigură-te că balanța ta este activă sau înregistrează-te pentru un trial gratuit API https://plagiarismsearch.com/ro/account/signup?from=%2Faccount%2Fapi
Mergi la Profilul Meu - Setări API și vei vedea API User și Key oferite personal pentru utilizarea ta https://plagiarismsearch.com/ro/account/api
Trimite un fișier sau text pentru verificarea plagiatului folosind autentificarea HTTP basic https://plagiarismsearch.com/docs/v3/reports/create. Iată un exemplu în CURL:
curl_setopt($curl, CURLOPT_USERPWD, $apiUser . ':' . $apiKey);
Vei primi un răspuns cu ID-ul raportului:
"data": { "id": 100500, "auth_key": "65jdgjhh7h452hjkh45k7535", ... }
Motorul nostru de detecție începe procesul de verificare a plagiatului.
După ce verificarea plagiatului este completată, sistemul trimite un POST web_hook la URL-ul asociat documentului trimis. În caz că URL-ul nu a fost indicat, sistemul trimite un POST web_hook la URL-ul asociat contului utilizatorului.
Există o metodă alternativă pentru a seta starea verificării plagiatului, deși nu este recomandată de echipa noastră. Aceasta presupune monitorizarea stării raportului https://plagiarismsearch.com/docs/v3/reports/status la intervale de timp, și verificarea dacă starea raportului este „Finalizat” (status=2), „Eroare” (status=-10), sau „Eroare server” (status=-11)
Când procesul de verificare a plagiatului este complet, poți obține informații detaliate folosind ID-ul raportului. Unul dintre exemple poate fi găsit aici: https://plagiarismsearch.com/docs/v3/reports/view

Poți specifica suplimentar parametrul `show_relations` pentru a obține mai multe date.

De exemplu,
const RELATIONS_SOURCES = -2; const RELATIONS_RAW = -1; const RELATIONS_NONE = 0; // implicit const RELATIONS_TREE = 1;

show_relations = -2 => returnează lista surselor ordonată după procentul de plagiat. Vezi câmpul de răspuns `data.sources`
show_relations = -1 => returnează toate datele raportului. Paragrafe, propoziții și surse cu text evidențiat. Vezi câmpul de răspuns `data.paragraphs`
show_relations = 1 => returnează toate datele raportului. Paragrafe, propoziții și surse cu text evidențiat. Vezi câmpul de răspuns `data.paragraphs`

Trebuie scripturile să aștepte rezultatul testului de plagiat sau există o funcție de callback care poate fi apelată ulterior pentru a obține rezultatul procesării documentului?

Există o solicitare POST de callback web_hook pe care o conectăm la utilizator. De asemenea, poți indica propriul tău URL de callback (personalizat) în setări când trimiti documentul ( https://plagiarismsearch.com/docs/v3/reports/create, https://plagiarismsearch.com/docs/v3/reports/callback-request)

Raportul poate fi descărcat în mai multe formate: (https://plagiarismsearch.com/docs/v3/reports/view) (Vezi "Răspuns")

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

Cum obțin un raport HTML?

Pentru a primi un link de raport HTML trebuie să trimiteți o cerere GET https://plagiarismsearch.com/api/v3/reports/{id} unde {id} este ID-ul raportului pentru care doriți să primiți raportul. În secțiunea “Răspuns” veți găsi link-ul raportului în câmpul `data.link`. De asemenea, în “Răspuns” veți găsi ‘data.auth_key’, cu care puteți genera 3 variante posibile ale rapoartelor HTML.

De exemplu, există 3 variante posibile de rapoarte HTML pentru 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

De asemenea, puteți genera link-uri de raport în 4 limbi diferite (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

Puteți combina diferite variante de rapoarte HTML și limbi pentru a primi raportul dorit în limba aleasă.

O schemă similară poate fi utilizată pentru a genera link-ul raportului PDF (aceste URL-uri pot fi vizualizate în “Răspuns” -> `data.files`).

De exemplu:

...
"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
   }
]
...

Nu pot găsi punctele finale/detalii despre cum să generezi tokenuri de acces.

Tokenul va fi în contul dumneavoastră după ce vă înregistrați (https://plagiarismsearch.com/ro/account/api)

Este necesar să-l transmiteți folosind autentificarea HTTP basic.

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

Aș dori să atașez fișierele în format DOCX, PDF și PPT pentru verificare. Este posibil?

Puteți atașa fișiere în mai multe formate: (https://plagiarismsearch.com/docs/v3/reports/create) șirul de fișiere sau încărcați fișierul pentru verificare.
De asemenea, puteți trimite fișiere cu numele `file`

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

Cum pot obține lista de URL-uri unde a fost găsit textul?

Trebuie să folosiți show_relations=1 sau, dacă aveți nevoie doar de surse (linkuri => procentul de plagiat) sau să apelați ruta (metoda POST) https://plagiarismsearch.com/api/v3/reports/sources/{reportId} (acum nedocumentată) și să utilizați câmpul `data.sources`

Cum pot exclude URL-ul meu din această listă?

Puteți apela ruta (metoda POST) https://plagiarismsearch.com/api/v3/reports/skip/{reportId} (nedocumentată acum) după verificarea raportului cu parametri POST

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

b) POST['source'] = {source.id} (de exemplu data.sources[0].id (integer)) sau

c) un array de URL-uri excluse
POST['urls'][] = 'https://wikipedia.org'
POST['urls'][] = 'https://plagiarismsearch.com'

un array de ID-uri de surse excluse
POST['sources'][] = {source.id}
POST['sources'][] = {source.id2}

Dacă apelați ruta de două ori - URL-urile vor fi incluse din nou, influențând procentajul general de plagiat

Pentru o utilizare mai transparentă, este mai bine să folosiți rute cu aceiași parametri descriși mai sus.
https://plagiarismsearch.com/api/v3/reports/exclude/{reportId} https://plagiarismsearch.com/api/v3/reports/include/{reportId}

De asemenea, avem planuri de a finaliza un set de funcționalități care ar permite excluderea URL-urilor aici: https://plagiarismsearch.com/api/v3/reports/create

Cum pot recalcula procentajul de plagiat după excludere?

Răspunsul la cerere va include procentajul general (modificat) de plagiat data.plagiat

Ce sunt "filter_references" și "filter_quotes"?

filter_references=1 => exclude referințele. Textul referințelor nu are impact asupra procentajului total de plagiat

filter_quotes=1 => exclude citările în text. Textul citat nu are impact asupra procentajului total de plagiat. Marcajele pentru citare sunt

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

Există o modalitate de a implementa API-ul prin CURL?

Iată câteva linii directoare care ar putea ușura implementarea CURL.

Încarcă documentul pentru verificarea plagiatului 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"'
Vizualizează raportul 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

De ce documentul are statutul “În așteptare” în stocare?

Documentul rămâne de obicei în statutul „În așteptare” pentru o perioadă scurtă de timp, de la 0 la 6 minute după ce a fost încărcat sau reîncărcat. Documentul este adăugat imediat în indexul de căutare.

Puteți verifica acest lucru și în codul programului: dacă au trecut 6 minute, documentul are statutul Activ.

Este posibil să aflați statutul documentului folosind următoarea metodă:

GET https://plagiarismsearch.com/api/v3/storage/{id}
Consultați câmpul `data.is_in_index`

Cum să încărcați documente în stocare prin API?

Puteți încărca documentele prin API:

POST https://plagiarismsearch.com/api/v3/storage/create
cu parametri, asemănători cu https://plagiarismsearch.com/docs/v3/reports/create

Upload to storage

De asemenea, puteți încărca documente într-o listă sau arhivă folosind formularul https://plagiarismsearch.com/storage/upload

Care sunt posibilitățile unui cont de revânzător? Cum îl integrez în propriul meu sistem?

Funcționalitățile oferite de contul nostru de revânzător sunt:

Fiecare utilizator nou trebuie să fie creat prin API (veți avea nevoie de nume de utilizator și parolă pentru a crea fiecare cont de utilizator)
Veți avea posibilitatea să acordați un număr anume de cuvinte fiecărui utilizator prin contul de revânzător.

Aceste opțiuni vor oferi posibilitatea fiecărui client să își folosească contul independent și veți putea adăuga cuvintele necesare pentru fiecare utilizator

Documentația tehnică necesară pentru integrare:

Trebuie să aveți un cont de tip revânzător pentru a putea crea clienți. Contactați-ne la services@plagiarismsearch.com pentru a primi acces la toate funcționalitățile unui cont de revânzător.

Creare client

Pentru a crea un client nou, trimiteți o cerere POST https://plagiarismsearch.com/api/v3/reseller-customers/create (Email-ul clientului este un câmp obligatoriu)

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

Răspuns

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

Lista clienților

Trimiteți o cerere GET 'https://plagiarismsearch.com/api/v3/reseller-customers' pentru a primi lista tuturor clienților creați.

De exemplu:
curl --location --request GET 'https://plagiarismsearch.com/api/v3/reseller-customers' \ --header 'Authorization: Basic your_user_key_combination=='

Vizualizați soldurile

Trimiteți o cerere GET https://plagiarismsearch.com/api/v3/reseller-customers/balance pentru a vizualiza soldul dumneavoastră.

Obțineți soldul dumneavoastră

Trimiteți o cerere GET https://plagiarismsearch.com/api/v3/reseller-customers/balance/{userId} pentru a vizualiza soldul unui client anume.

Exemplul de răspuns pentru sold:

{
   "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"
}

Plătiți soldul clientului

Adăugați numărul necesar de trimiteri sau cuvinte la contul unui client specificat prin introducerea ID-ului utilizatorului și a sumei în câmpul `words` sau `submissions` (1 trimitere = 1000 cuvinte).

De exemplu:
curl --location --request POST 'https://plagiarismsearch.com/api/v3/reseller-customers/pay/26784' \ --header 'Authorization: Basic your_user_key_combination==' \ --form 'words="1000"'

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

Cum să corectați eroarea: 400 Bad Request atunci când trimiteți text pentru verificarea plagiatului?

Exemplul de eroare pe care îl puteți obține când trimiteți text pentru verificarea plagiatului ar putea arăta astfel:

Metoda cererii: PUT
Status Code: 400 Bad Request

Răspuns: Nu există instanțe disponibile pentru plagiarismsearch.com

API-ul de Plagiat utilizat: https://plagiarismsearch.com/api/v3/reports/create

Soluție:

Clientul ar trebui să folosească metoda POST (nu PUT) așa cum se vede în captura de ecran

400 Bad Request

Există o eroare de autentificare în timp ce rulez /report pe GET folosind modulul request în Python.

Trebuie să trimiteți datele de autentificare pentru fiecare nouă cerere.

Folosim autentificarea de bază, de exemplu 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')) // Autentificare HTTP basic Php folosind CURL curl_setopt($curl, CURLOPT_USERPWD, $apiUser . ':' . $apiKey);