Naar hoofdinhoud gaan
De Clarus REST- en GraphQL-API wordt beschreven door een OpenAPI-specificatie. Download hem en importeer hem in je favoriete API-client om voor elk gedocumenteerd endpoint een kant-en-klaar verzoek te krijgen.

Download de OpenAPI-spec

clarus-api.json — de volledige Clarus API-specificatie.
Je moet ingelogd zijn op deze documentatie om de spec te downloaden.
Je kunt je tool ook naar de URL van de spec laten verwijzen in plaats van een opgeslagen bestand, zodat deze up-to-date blijft naarmate de API zich ontwikkelt. Klik met de rechtermuisknop op de downloadlink hierboven en kopieer het adres om de volledige URL te krijgen.

​
Voordat je begint

Welke tool je ook gebruikt, elk verzoek heeft twee dingen nodig (zie Authenticatie en toegang):
  • Een OAuth 2.0-bearertoken in de Authorization-header.
  • Je tenant-header X-Clarus-Subdomain.
Stel beide één keer in op het niveau van de collection of environment, zodat ze voor elk verzoek gelden.

​
Importeren in je tool

1

Importeer de spec

Klik in Postman op Import en sleep het bestand clarus-api.json erin (of plak de URL van de spec).
2

Genereer de collection

Postman maakt een collection met een verzoek voor elk endpoint, gegroepeerd per tag.
3

Stel authenticatie in

Kies op het tabblad Authorization van de collection voor Bearer Token en plak je access token. Voeg een X-Clarus-Subdomain-header toe — een collection-variabele werkt goed, zodat je makkelijk van tenant kunt wisselen.
4

Verstuur een verzoek

Open een verzoek, vul indien nodig de body in en klik op Send.
Verzoeken die je vanuit deze tools verstuurt, handelen met de rechten van het token dat je gebruikt en het subdomein dat je instelt — precies zoals bij het rechtstreeks aanroepen van de API. De API kan gegevens lezen en wijzigen, dus wees voorzichtig met welke verzoeken je tegen een live tenant uitvoert.
De spec dekt REST-mutatie-endpoints en GraphQL-lijstquery’s. Voor het ophalen van gegevens met GraphQL, zie Updates ophalen.