PlagiarismSearch API: Vragen en antwoorden over integratie

Een praktische handleiding voor API-toegang, asynchrone plagiaatcontroles, callbacks, rapporten, privéopslag (Storage), filters en veelvoorkomende integratieproblemen.

De schermafbeeldingen tonen een eerdere API-workflow. Raadpleeg de gekoppelde v3-documentatie en uw accountinstellingen voordat u integraties in productie implementeert.

Wat kan de PlagiarismSearch API?

De PlagiarismSearch RESTful API stelt ontwikkelaars in staat om tekst of ondersteunde bestanden in te dienen voor gelijkenisanalyse, resultaten en broninformatie op te halen en plagiaatcontrole te koppelen aan de eigen workflow van een organisatie. Private Storage kan vergelijkingen ondersteunen met documenten die de klant kiest om te indexeren.

API-functies en -machtigingen zijn afhankelijk van het account en de ingeschakelde services. Ga er niet vanuit dat resellerbewerkingen, schrijftoegang tot opslag (Storage) of AI-detectie in elk account zijn inbegrepen. Een AI-schrijfsignaal staat los van een plagiaat- of gelijkenisdetectie.

Hoe verkrijg ik API-toegang en inloggegevens?

Begin met het openbare Plagiarism API-overzicht en de API-documentatie. Als u toegang tot een proefperiode of informatie over de prijs nodig heeft, neem dan contact op met services@plagiarismsearch.com om de actuele voorwaarden te bevestigen. Oudere documenten beschrijven een proefperiode van 30 dagen met 100 inzendingen, maar deze exacte voorwaarden zijn niet geverifieerd voor de huidige registraties.

Voor een bestaand account kunt u de bevestigde pagina API Credentials in de app gebruiken om uw API-gebruiker en -sleutel te controleren. Bewaar de inloggegevens op de server. Plak nooit live sleutels in supporttickets, openbare broncode of een applicatie die alleen in de browser werkt.

Hoe werkt de asynchrone rapportageworkflow?

  1. Dien een tekst, bestand of toegestane openbare URL in via reports/create.
  2. Noteer het ID van het geretourneerde rapport en controleer of het verzoek is geaccepteerd. Saldo- en accountmachtigingen kunnen de verwerking beïnvloeden.
  3. De server verwerkt de aangeleverde inhoud asynchroon. De verwerkingstijden variëren afhankelijk van de documentgrootte, de beschikbare resources en de gekozen analyseopties; ga er niet vanuit dat de verwerking binnen een vaste tijdslimiet voltooid zal zijn.
  4. Ontvang een melding van voltooiing op de geconfigureerde callback_url, of gebruik de gedocumenteerde workflow voor het rapporteren van de status indien van toepassing.
  5. Bekijk de details en beschikbare rapportlinks via reports/{id}.

Raadpleeg de referentie voor callbackverzoeken. Uw endpoint moet via HTTPS bereikbaar zijn, inkomende verzoeken valideren volgens het huidige integratiecontract en nieuwe pogingen of dubbele meldingen veilig afhandelen.

Hoe ziet een verzoek tot het aanmaken van een rapport eruit?

De gedocumenteerde aanmaakmethode is POST, niet PUT. Het onderstaande voorbeeld illustreert de structuur van een verzoek; gebruik uw API-gebruiker en -sleutel aan de serverzijde en controleer de exacte ondersteunde parameters in de documentatie.

curl --request POST \
  'https://plagiarismsearch.com/api/v3/reports/create' \
  --user 'YOUR_API_USER:YOUR_API_KEY' \
  --form 'text=Example document text for a similarity check.' \
  --form 'search_web=1' \
  --form 'search_storage=0' \
  --form 'callback_url=https://your-domain.example/api/plagiarism-callback'

Gebruik het formulierveld file bij het verzenden van een bestand. De API-documentatie beschrijft ook url, title, remote_id en optionele filters. Vermijd het opnemen van authenticatiegegevens in queryreeksen of schermafbeeldingen.

Hoe dien ik een bestand in en hoe bekijk ik een rapport?

Een typische bestandsinzending maakt gebruik van het gedocumenteerde veld file; een voltooid rapport kan worden opgehaald via GET /api/v3/reports/{id}. Deze twee schermafbeeldingen zijn afkomstig uit de oudere integratiehandleiding en dienen ter illustratie, niet ter vervanging van de huidige API-referentie.

Eerder cURL-voorbeeld voor het indienen van een document via de PlagiarismSearch API
Eerder voorbeeld van een API cURL-inzending; controleer de huidige authenticatie en veldnamen voordat u deze opnieuw gebruikt.
Eerder cURL-voorbeeld voor het ophalen van een PlagiarismSearch API-rapport
Voorbeeld van het ophalen van een eerder rapport. Een rapport-ID en een geauthenticeerd verzoek zijn vereist.

Hoe kan ik bronnen en rapportdetails opvragen?

Het v3-rapportweergave-eindpunt ondersteunt show_relations. De gedocumenteerde waarden helpen bepalen hoeveel informatie er wordt geretourneerd:

  • 0 — basisrapportinformatie (standaard).
  • 1 — gestructureerde rapportstructuur met alinea's, zinnen, bronnen en gemarkeerde tekst.
  • -1 — ruwe rapportrelaties.
  • -2 — een lijst met bronovereenkomsten.
  • -3 — HTML-rapportinhoud, indien ondersteund.

Voorbeeld: GET https://plagiarismsearch.com/api/v3/reports/REPORT_ID?show_relations=-2. Inspecteer het responsschema in de huidige endpointreferentie in plaats van URL's te bouwen op basis van verouderde, hardgecodeerde rapportsleutels.

Overeenkomstscores en bronpercentages dienen als bewijsmateriaal voor beoordeling, niet als automatische vaststelling van plagiaat. Optionele AI-contentvelden, indien beschikbaar, vertegenwoordigen een andere analyse.

Kan ik de resultaten downloaden als HTML- en PDF-bestand?

Rapportreacties kunnen een via de browser toegankelijke HTML-link en vermeldingen in een files-array voor PDF-varianten bevatten, afhankelijk van het account en de API-respons. Gebruik bij voorkeur de rapport-URL's die voor dat specifieke rapport worden geretourneerd in plaats van handmatig ID's en toegangssleutels samen te voegen.

Publiceer geen URL's van rapporten met autorisatiesleutels op openbaar toegankelijke pagina's of in logboeken. Toegang tot rapporten en de bewaring ervan zijn onderworpen aan de huidige account-, deel- en gegevensbewaringsregels; de oude bewering dat elk rapport voor altijd beschikbaar blijft, moet niet langer worden gebruikt. Zie de interpretatiehandleiding voor gelijkenisrapporten en informatie over gegevensverwerking.

Hoe werken uitsluitingen en zoekfilters?

Het aanmaak-eindpunt documenteert referentie- en citaatfilters, web- en opslagselectie (Storage) en URL-opties. Zo zijn filter_references en filter_quotes gedocumenteerde aliassen voor het uitsluiten van referentielijst- of citaatinhoud; search_web en search_storage selecteren broncollecties.

De API-documentatie maakt onderscheid tussen search_web_disable_urls en search_web_exclude_urls. Bij de laatste optie blijft overeenkomend bewijsmateriaal zichtbaar, terwijl bepaalde sites worden uitgesloten van de berekende score. Een lagere score na het toepassen van uitsluitingen betekent niet dat de oorspronkelijke tekst is veranderd of origineler is geworden.

Gebruik de zoekfiltergids voor interpretatie. Controleer de instellingen voor niet-Latijnse en meertalige tekst voordat u filters voor alleen Latijnse teksten inschakelt.

Hoe kan ik bestanden uploaden naar en zoekopdrachten uitvoeren in privéopslag (Storage)?

Privéopslag (Storage) is een optionele, door de klant beheerde verzameling voor vergelijking met geselecteerde, eerder geïndexeerde documenten. Dit is iets anders dan een rapportgeschiedenis. De oude handleiding toont de uploadroute POST /api/v3/storage/create en verwijst naar het statusveld is_in_index; controleer deze bewerkingen en de bijbehorende machtigingen in de huidige API-referentie van het account.

Vorige PlagiarismSearch API opslag upload interface
Ouder voorbeeld van het uploaden van documenten naar Storage. Indexering is niet altijd direct voltooid; controleer of het systeem gereed is voordat u naar een recent geüpload document zoekt.

Upload alleen documenten die u mag verwerken en indexeren. Het toevoegen van een document aan de opslag (Storage) is iets anders dan het controleren van een nieuw document op overeenkomsten; vermijd het automatisch opslaan van elke ingediende tekst, tenzij de workflow dit expliciet vereist.

Biedt de API ondersteuning voor resellers en workflows voor meerdere gebruikers?

In de oude documentatie worden reselleraccounts beschreven die klantgegevens aanmaken en controlemiddelen toewijzen via resellerspecifieke routes. Deze mogelijkheden zijn accountafhankelijk en mogen niet standaard als beschikbaar worden gepresenteerd. Neem contact op met services@plagiarismsearch.com voor de actuele resellerrechten, toegang tot eindpunten en een veilig implementatieplan.

Gebruik de oude wachtwoordvoorbeelden nooit als productiepatronen. Genereer op een veilige manier unieke inloggegevens, vermijd het terugsturen van onbewerkte wachtwoorden naar logbestanden of clients, en controleer of de workflows voor het aanmaken en toewijzen van klanten nog steeds de oude interface /api/v3/reseller-customers gebruiken.

Waarom krijg ik 400-fouten, authenticatiefouten of resultaten die nog in behandeling zijn?

400 Bad Request

Controleer eerst de HTTP-methode: het gedocumenteerde eindpunt voor het aanmaken van rapporten gebruikt POST. Valideer de veldnamen, het inhoudstype, de bestandsgrootte, de verplichte tekstvelden en de daadwerkelijke foutmelding; een HTTP 400 kan meerdere oorzaken hebben.

Oudere screenshot van de PlagiarismSearch API die een HTTP 400-fout en de bijbehorende aanvraagmethode illustreert.
Voorbeeld van probleemoplossing met behulp van legacy-software. Het illustreert één mogelijke methode-mismatch, en is geen universele verklaring voor elke 400-respons.

401 / authentication error

Controleer of het API-gebruikers-/sleutelpaar actief is en met elk verzoek wordt meegestuurd met behulp van het authenticatieschema dat vereist is door het eindpunt. Bekijk de pagina met API-gegevens van het account. Plaats geen geheime sleutels in openbare JavaScript-code en deel ze niet in schermafbeeldingen.

Document nog in behandeling

Een ingediend rapport of opslagdocument (Storage) is mogelijk nog niet gereed. Controleer de status van het gedocumenteerde rapport of de indexeringsstatus van de opslag in plaats van uit te gaan van een vaste voltooiingstijd van 0-6 minuten. Behandel fouten en herhaalpogingen apart van voltooide rapporten.

Waar moeten ontwikkelaars zich nu op richten?

Begin bij een nieuwe integratie met API-documentatie, controleer de ingeschakelde accountfuncties en test vervolgens een kleine steekproef met echte tekst en bewust verschillende bronnen. Registreer alleen technische metadata die veilig bewaard kunnen worden, bescherm API-gegevens en vergelijk een geretourneerd antwoord met het gedocumenteerde schema voordat u geautomatiseerde rapporten genereert.

Voor vragen over toegang of installatie kunt u contact opnemen met services@plagiarismsearch.com of het Helpcentrum raadplegen. De openbare Plagiarism API-pagina beschrijft het product en de contactmogelijkheden.

Bouw met een betere integratie

Gebruik de gedocumenteerde API-workflow, bescherm uw inloggegevens en verifieer de reacties waarop uw integratie is gebaseerd.