Weergeven als Markdown

Foutafhandeling

De Proctorio API gebruikt standaard HTTP-statuscodes en retourneert gestructureerde foutresponsen.

HTTP-statuscodes

CodeBetekenis
200Succes — verzoek voltooid en URL is gegenereerd
400Ongeldig verzoek — validatie mislukt voor een of meer velden
401Niet geautoriseerd — ongeldige of ontbrekende API-sleutel
429Te veel verzoeken — snelheidslimiet overschreden
500Serverfout — interne fout, probeer opnieuw met exponentiële vertraging

Indeling van foutrespons

Validatiefouten (400) retourneren een array van foutobjecten:

[
  {
    "memberNames": ["launch_url"],
    "errorMessage": "The launch_url field is required."
  },
  {
    "memberNames": ["exam_settings"],
    "errorMessage": "exam_settings is required."
  }
]

401-foutcodes

CodeBeschrijving
2154Account niet actief — neem contact op met uw accountmanager
2155Onjuiste regio — gebruik het juiste regionale endpoint
2655Ongeldige API-sleutel — controleer uw sleutelwaarde

Beste werkwijzen

  • Valideer altijd uw verzoekpayload voordat u het verzendt
  • Implementeer logica voor opnieuw proberen met exponentiële vertraging voor 5xx-fouten
  • Log de volledige foutresponstekst voor foutopsporing
  • Stel uw API-sleutel nooit bloot in code aan de clientzijde