API-documentatie

• SnelstartVan testsleutel tot een afgeronde onboarding in de sandbox, met curl en TypeScript.
• AuthenticatieAPI-sleutels, rechten, de Idempotency-Key, versies en werken namens werkgevers.
• WebhooksGebeurtenissen, de inhoud van een bericht en de handtekening controleren.
• Inbedden en terugsturenDe onboarding in je eigen site met embed.js, en terug naar je app met return_url.
• Sandbox en livegangTesten met fictieve medewerkers en productietoegang aanvragen.
• Fouten en limietenDe vaste foutvorm, foutcodes, de snelheidslimiet en bladeren.
• API-referentieAlle endpoints met recht, parameters en voorbeelden, uit de OpenAPI-spec.

Zo werkt het#

1. Create. Maak een onboarding aan met POST /v1/onboardings. Je krijgt een id, een hosted_url en een vervaldatum terug.
2. Redirect. Stuur de medewerker naar de hosted_url. Die pagina is in de huisstijl van de werkgever.
3. Verify. De medewerker bevestigt met een eenmalige code per mail of sms. De link alleen geeft nooit toegang tot een dossier.
4. Webhook. Volg de voortgang met ondertekende webhooks, of vraag de stand op met GET /v1/onboardings/{id}.

Daartussen regelt Agreli de formulieren, de scan van het identiteitsbewijs, de vierogencontrole, het contract en de verwerking in de salarisadministratie. Alle regels die in het dashboard gelden, gelden ook via de API: de API gebruikt dezelfde backend.

Basisgegevens#

• Basis-URL: https://app.agreli.nl/api/public. Alle paden beginnen met /v1.
• Authenticatie: Authorization: Bearer hrs_live_… voor productie, hrs_test_… voor de sandbox.
• Formaat: JSON met velden in snake_case en id's met een voorvoegsel, zoals onb_…, org_… en loc_…. Bedragen in centen, datums en tijden volgens ISO 8601.
• Taal: het product en de foutmeldingen zijn Nederlands. De code van een fout is stabiel en bedoeld voor je programma.
• Specificatie: OpenAPI 3.1 op https://app.agreli.nl/api/public/v1/openapi.json. De referentie op deze site wordt daaruit gegenereerd.

Voor AI-assistenten#

Bouw je de koppeling met Cursor, Claude Code, ChatGPT of een andere assistent? Geef die de documentatie als Markdown:

• llms.txt: de index van alle documentatie, volgens de llms.txt-conventie.
• llms-full.txt: de complete API-documentatie in één bestand, in het Engels.
• OpenAPI-specificatie: machineleesbaar, ook voor Postman, n8n of een SDK-generator.
• Elke pagina hier bestaat ook als Markdown: zet .md achter het adres, zoals /docs/snelstart.md. De knop "Kopieer voor AI" bovenaan elke pagina doet hetzelfde.

In Cursor voeg je https://agreli.nl/llms-full.txt toe als documentatie via @Docs. In Claude Code of ChatGPT plak je de link in je vraag. Deze opdracht kun je zo gebruiken:

Bouw een koppeling met de Agreli Hosted Onboarding API.
Lees eerst https://agreli.nl/llms-full.txt en gebruik https://app.agreli.nl/api/public/v1/openapi.json als bron voor endpoints en velden.
Gebruik een testsleutel (hrs_test_…) uit de omgevingsvariabele AGRELI_API_KEY.
Stuur bij elke POST een Idempotency-Key mee en controleer de Agreli-Signature van elke webhook.