v1

Verzoeken doen

Basis-URL, JSON-LD-headers, paginering en foutafhandeling.

De Resolved-API is gebouwd met API Platform en spreekt JSON-LD (met Hydra voor collecties). Elk verzoek wordt geauthenticeerd met het bearer token dat je verkreeg bij Authenticatie.

Basis-URL en headers

Stuur het access token mee in de Authorization-header. Vraag voor antwoorden om JSON-LD:

curl https://api.resolved.nl/api/case_files \
  -H "Authorization: Bearer JOUW_ACCESS_TOKEN" \
  -H "Accept: application/ld+json"
Header Wanneer Waarde
Authorization Elke call Bearer JOUW_ACCESS_TOKEN
Accept Lezen en schrijven application/ld+json
Content-Type POST / create-bodies application/ld+json
Content-Type PATCH application/merge-patch+json

Alleen JSON-LD is ingeschakeld voor API-resources. Gebruik Accept: application/ld+json. Zonder Accept krijg je ook JSON-LD (dat is de default). Stuur geen Accept: application/json — dat mediatype is niet ingeschakeld en de API weigert het.

Antwoorden bevatten JSON-LD-context (@context, @id, @type) en Hydra-collectiemetadata. Gebruik IRI's (@id) als stabiele identifiers bij het koppelen van resources.

Paginering

Collectie-endpoints zijn gepagineerd met Hydra. Volg hydra:next binnen hydra:view in plaats van zelf paginanummers op te bouwen, zodat je integratie blijft werken als de pagineringsstrategie verandert.

Blijf hydra:next volgen tot die ontbreekt. Ga niet uit van een vaste paginagrootte.

Rate limits

Verzoeken vallen onder rate limits per app. Overschrijd je een limiet, dan antwoordt de API met 429 Too Many Requests en een Retry-After-header. Wacht het aangegeven aantal seconden en probeer opnieuw.

Fouten

De API gebruikt standaard HTTP-statuscodes. Foutbodies zijn ook JSON-LD en bevatten een machinaal leesbare detail (en gerelateerde velden):

{
  "@context": "/api/contexts/Error",
  "@type": "hydra:Error",
  "status": 403,
  "detail": "This app is not authorized for the requested scope."
}
  • 401 — het access token ontbreekt of is verlopen. Vernieuw het en probeer opnieuw.
  • 403 — het token is geldig, maar de app mist de vereiste scope.
  • 404 — de resource bestaat niet of valt buiten de verleende locaties.
  • 406 — niet-ondersteunde Accept (bijvoorbeeld plain application/json).
  • 415 — niet-ondersteunde request-Content-Type bij writes.
  • 429 — je wordt gelimiteerd; respecteer Retry-After.

Reageer vervolgens direct op wijzigingen met Webhooks.