De Hix REST API stelt je in staat om je eigen systemen te koppelen aan het Hix-platform. Via de API kun je bedrijven, gebruikers, taken en vragen beheren, webhooks instellen en meer.
Base URL
Alle API-endpoints beginnen met:
https://[jouw-domein]/api/v1/Vervang [jouw-domein] door het domein van jouw Hix-omgeving.
Versiebeheer
De huidige stabiele versie is v1. Endpoints onder /api/v1/ zijn stabiel en krijgen geen breaking changes zonder aankondiging vooraf.
Request-formaat
- Stuur alle requests met de header
Content-Type: application/json - Request bodies zijn JSON
- Alle responses zijn JSON
- De API communiceert in het Engels
Response-formaat
Succesvolle lijst-responses hebben de volgende structuur:
{
"data": [ ... ],
"meta": {
"current_page": 1,
"last_page": 5,
"per_page": 15,
"total": 72
}
}Foutresponses:
{
"message": "Unauthenticated.",
"code": 401
}HTTP-statuscodes
| Code | Betekenis |
|---|---|
| 200 | OK - request geslaagd |
| 201 | Created - resource aangemaakt |
| 401 | Unauthenticated - token ontbreekt of is ongeldig |
| 403 | Forbidden - onvoldoende rechten |
| 404 | Not Found - resource bestaat niet |
| 422 | Unprocessable Entity - validatiefout in de request body |
| 429 | Too Many Requests - rate limit overschreden |
Rate limiting
De API staat maximaal 60 requests per minuut toe per token. Bij overschrijding ontvang je een 429-response.