Sjel API

Accountgegevens, opdrachten en webhooks

De Sjel API gebruikt Bearer API keys uit Mijn Sjel. Account keys en provider keys hebben gescheiden scopes. De productie-base URL is https://sjel.nl/api/v1.

Swagger openen OpenAPI JSON API key beheren

Authenticatie

Bearer token

Stuur je key mee via de Authorization-header. API keys zijn gekoppeld aan je dienstprofiel en geven alleen toegang tot je eigen opdrachten.

Authorization: Bearer sjel_live_...

Voorbeeld

Account ophalen

curl https://sjel.nl/api/v1/account/me \
  -H "Authorization: Bearer sjel_acc_..."

Voorbeeld

Objecten en workflows

curl https://sjel.nl/api/v1/account/objects \
  -H "Authorization: Bearer sjel_acc_..."

Voorbeeld

Provideropdrachten ophalen

curl https://sjel.nl/api/v1/provider/assignments \
  -H "Authorization: Bearer sjel_live_..."

GET

/account/me

Toont het account dat hoort bij je account API key, inclusief klantnummer, taal en actieve scopes.

GET/POST/PATCH

/account/objects

Beheer eigen woningen/objecten, inclusief huurcontractstatus, einddatum, opzegdeadline en workflow-samenvatting.

GET/POST

/account/objects/{id}/workflows

Lees object-workflows uit of start een workflow. Als betaling nodig is, geeft de API waiting_for_payment terug met een Mijn Sjel betaallink.

{
  "workflow_type": "energielabel",
  "mode": "order_service"
}

GET

/provider/assignments

Toont de opdrachten die aan jouw dienstprofiel gekoppeld zijn.

PATCH

/provider/assignments/{id}/status

Werk de operationele status bij, zoals afspraak bevestigd, opname afgerond of opdracht afgerond.

POST

/provider/assignments/{id}/appointments

Stel een of meerdere afspraakmomenten voor aan de klant.

{
  "starts_at": [
    "2026-06-18T09:30:00+02:00",
    "2026-06-18T13:00:00+02:00"
  ],
  "duration_minutes": 60,
  "note": "Kies een moment dat het beste past."
}

POST

/provider/assignments/{id}/documents

Upload het resultaatdocument, zoals een energielabel of rapport.

curl https://sjel.nl/api/v1/provider/assignments/123/documents \
  -H "Authorization: Bearer sjel_live_..." \
  -F "[email protected]" \
  -F "note=Definitief label"

POST

/provider/assignments/{id}/customer-invoice

Upload de klantfactuur die hoort bij marketplace-diensten waarbij jij de formele leverancier bent.

GET/POST/DELETE

/provider/webhook-endpoints

Beheer webhook endpoints voor opdrachtupdates, documentuploads, afrondingen en payout-updates.

Afspraakmomenten

Velden en validatie

starts_at is verplicht en bevat 1 tot 5 toekomstige ISO 8601 datums met timezone. duration_minutes is optioneel en moet tussen 15 en 240 minuten liggen. note is optioneel.

Swagger

Volledige referentie

Swagger wordt in CI gecontroleerd tegen de echte provider-routes. Als een endpoint ontbreekt in OpenAPI, mag de deploy niet door.

Swagger reference openen

Sandbox

Testopdracht maken

In Mijn Sjel kan een dienstverlener een sandbox-opdracht aanmaken. Daarmee kun je API-calls, afspraakmomenten, documentuploads en webhooks testen zonder echte klantbetaling.

Mijn Sjel openen