📘 Algemene API bronnen
Welkom bij de Esadax API referentie. Hier vindt u alle essentiële informatie die u nodig hebt om met onze API te werken, inclusief hoe u zich kunt verifiëren, antwoordstatussen kunt begrijpen en validatiefouten kunt oplossen.
Authenticatie
Alle API-verzoeken moeten worden geverifieerd met behulp van een API-token. Dit wordt gedaan door een Authorization-header toe te voegen aan uw HTTP-verzoek.
✅ Koptekstformaat
Authorization: Bearer XXX
Vervang XXX door uw eigenlijke API-token.
Over API-tokens
- API-tokens worden gegenereerd per gebruikersaccount.
- Elk token kan aangepaste machtigingen hebben om de toegang tot specifieke gebieden van uw account te beperken.
- Dit helpt uw integratie veilig te houden door alleen de toegang te verlenen die nodig is.
➡️ Lees meer over het beheren van API-tokens
API-reacties
Esadax maakt gebruik van RESTful-principes en voldoet aan standaard HTTP-responspraktijken. Elke reactie van de API bevat een relevante HTTP-statuscode om aan te geven of uw verzoek is geslaagd of mislukt.
📊 HTTP-statuscodes
| Code | Naam | Beschrijving |
|---|---|---|
| 200 | Oké. | Het verzoek is succesvol geaccepteerd. |
| 201 blz. | Aangemaakt | De bron is succesvol aangemaakt. |
| 202 blz. | Aanvaard | Het verzoek is geaccepteerd en de verwerking gaat door op de achtergrond. |
| 204 blz. | Er is geen inhoud | Het verzoek is geaccepteerd, maar er is geen inhoud om terug te keren. |
| 400 | Slecht verzoek | Er is een fout opgetreden tijdens het verwerken van uw verzoek. Controleer de eindpuntvereisten en probeer het opnieuw. |
| 401 | Niet geautoriseerd | Ongeldig API token. Lees meer. |
| 403 blz. | Verboden | De actie is niet toegestaan voor dit token of account. Controleer token machtigingen. |
| 404 Pagina niet gevonden | Pagina niet gevonden | De opgevraagde pagina bestaat niet (meer). |
| 405 v.Chr. | Methode niet toegestaan | De gebruikte HTTP-methode wordt niet ondersteund voor dit eindpunt. |
| 408 v.Chr. | Time-out aanvragen | Er was een time-out aan onze kant. Neem dan contact op met support. |
| 421 blz. | Service niet beschikbaar | Deze website ondergaat op dit moment gepland onderhoud. Probeer het later nog eens. |
| 422 blz. | Onverwerkbare entiteit | Er is een validatiefout opgetreden in uw aanvraag. Controleer en probeer het opnieuw. Lees meer |
| 429 v.Chr. | Te veel verzoeken | Tarieflimiet overschreden. Lees meer over snelheidslimieten |
| 500 | Interne serverfout | Er is een serverfout opgetreden. Neem dan contact op met support. |
| 502 blz. | Slechte gateway | Tijdelijk systeemprobleem. Neem dan contact op met support. |
| 503 blz. | Service niet beschikbaar | Deze website is momenteel niet beschikbaar. Neem dan contact op met support. |
| 504 blz. | Time-out van gateway | Er is een time-out opgetreden op ons systeem. Neem dan contact op met support. |
🔗 Meer informatie over HTTP-statuscodes is te vinden op Mozilla Developer Network.
SQL Server Validatiefout
Validatiefouten (HTTP 422) treden op wanneer de payload van uw verzoek niet voldoet aan de vereisten voor een bepaald eindpunt. Dit kan komen door:
- Ontbrekende vereiste velden
- Ongeldige gegevensindelingen
- Onjuiste parameters
Controleer altijd de API-eindpuntdocumentatie om ervoor te zorgen dat de hoofdtekst van uw verzoek overeenkomt met de verwachte indeling.
