Foutmeldingen
De statuscodes en foutcodes die de API teruggeeft, en hoe je ermee omgaat.
Een mislukt verzoek geeft een HTTP-statuscode terug en een JSON-body met een error-object:
{
"error": {
"code": "CONFLICT",
"message": "A Space with this name already exists",
"reason": "NAME_TAKEN"
}
}| Veld | Beschrijving |
|---|---|
code | De foutcode uit de tabel hieronder. Baseer je foutafhandeling hierop. |
message | Een beschrijving voor mensen, altijd in het Engels. De tekst kan veranderen, dus vergelijk er niet op. |
reason | Optioneel. De specifieke oorzaak, zoals NAME_TAKEN of SLUG_TAKEN. De waarden veranderen niet. |
Statuscodes
| Status | code | Wanneer |
|---|---|---|
400 | VALIDATION_ERROR | Het verzoek is ongeldig: een veld ontbreekt of klopt niet, of de body is geen geldige JSON. |
401 | — | Het access token ontbreekt, is ongeldig of verlopen, of mist een scope. Zie 401 Unauthorized. |
403 | NOT_ENTITLED | Het abonnement van je organisatie bevat de functie niet, zoals standaardprojecten bij het aanmaken van een Space. |
403 | FORBIDDEN | De client of gebruiker van het token heeft niet de rol in de Space die het verzoek vraagt: Kan beheren om een Space te verwijderen (voor het token van een gebruiker ook beheerder of eigenaar van de organisatie), een rol om een Space te wijzigen die niet elk lid kan bewerken, of een rol om een beperkte Space te lezen. De reason is ROLE_REQUIRED. Zie Beperkte Spaces en Spaces die niet elk lid kan bewerken. |
404 | NOT_FOUND | De Space of connectie bestaat niet, of hoort bij een andere organisatie. |
409 | CONFLICT | Er bestaat al een Space met die naam of slug (NAME_TAKEN, SLUG_TAKEN), of iemand anders wijzigde de Space terwijl je wijziging werd opgeslagen (CHANGED). |
500 | INTERNAL_ERROR | Er ging aan onze kant iets mis. |
401 Unauthorized
Een 401 heeft een andere body: error is een melding, geen object.
{
"error": "Invalid or expired token"
}Controleer in deze volgorde:
- Het token is verlopen. Haal een nieuw token op en probeer het opnieuw (zie Token vernieuwen).
- Het token mist de scope. De scope van het endpoint staat in de tabel Scopes. Voeg hem toe met Scopes bewerken… en haal een nieuw token op: een token houdt de scopes waarmee het is uitgegeven.
- De client is uitgeschakeld of verwijderd. Controleer de rij van de client op API instellingen.
Batchverzoeken
Batch Create Spaces meldt het resultaat per Space. Elk resultaat bevat space of error, en de status zegt hoe de batch ging: 201 als elke Space is aangemaakt, 207 als een deel is aangemaakt, 400 als er geen is aangemaakt.
Fouten afhandelen
- Herhaal een
400,403,404of409niet ongewijzigd: hetzelfde verzoek krijgt hetzelfde antwoord. De uitzondering is een409met de reasonCHANGED: haal de Space op, controleer of je wijziging nog klopt en stuur hem opnieuw. - Haal na een
401één keer een nieuw token op en probeer het opnieuw. Een tweede401wijst op een probleem met de scope of de client. - Herhaal een
500na een pauze. Blijft het misgaan? Mail support@tibata.ai.