Scopes - Codaclean API

Codaclean kent aan elke API-sleutel een reeks scopes toe. Elk endpoint vereist één scope, die op zijn referentiepagina vermeld staat. Een aanroep zonder de vereiste scope geeft 403 terug, met de code forbiddenScope.

Scope	Toegestane acties
`customers:read`	Klanten zoeken en raadplegen, banken en sociale secretariaten opvragen.
`customers:write`	Klanten aanmaken en wijzigen, bankrekeningen en sociale secretariaten toevoegen.
`customers:delete`	Klanten archiveren, bankrekeningen deactiveren, sociale secretariaten verwijderen.
`mandates:read`	Mandaten zoeken en raadplegen.
`mandates:write`	CODA- en CODB-mandaten aanvragen.
`files:read`	CODA- en CODB-bestanden opvragen en de download ervan bevestigen.
`files:write`	Inloggegevens verkrijgen om CODA- en CODB-bestanden te uploaden.

Standaardscopes

Standaard heeft een API-sleutel alleen de leesscopes customers:read, mandates:read en files:read, tenzij Codaclean iets anders heeft ingesteld. Schrijf- en verwijderscopes worden altijd uitdrukkelijk toegekend. Hebt u meer scopes nodig? Neem contact op met Codaclean.

Beperkingen door het boekhoudkantoor

Een boekhoudkantoor kan de scopes van uw API-sleutel beperken voor zijn eigen gegevens. Het kan ze alleen inperken, nooit uitbreiden. Gebruikt u een scope die het kantoor heeft ingetrokken, dan krijgt u forbiddenScope, maar alleen voor de gebruikers van dat kantoor.

Wijzigingen in de scopes worden binnen ongeveer een minuut van kracht.

Endpoints zonder scope

POST /token en GET /hello vereisen geen scope.