Naar hoofdinhoud gaan
Al onze API-calls draaien op GraphQL, en onze publieke API volgt dezelfde standaard. Geschreven referentiemateriaal is beperkt, daarom voorzien we een Apollo Sandbox-omgeving waar je calls rechtstreeks kunt uitproberen. De sandbox bevat uitleg bij de beschikbare queries, velden en interfaces.
We bouwen geen maatwerkoplossingen bovenop de API. Heb je uitgebreidere ondersteuning nodig, dan raden we aan om met een van onze partners te werken.
Laat ons weten wat je wilt bereiken via lead.development@outkept.com, dan wijzen we je de juiste richting.

​
Toegang aanvragen

Toegang tot de API en de sandbox is beperkt tot gewhiteliste IP-adressen. Voor je een call kunt doen, vraag je whitelisting aan voor het IP of de IP’s waarmee je verbinding maakt.
1

Dien een aanvraag in

Dien een aanvraag voor IP-whitelisting in via Jira Support. Je kunt meerdere IP-adressen in één keer aanvragen.
2

Wacht op bevestiging

Zodra je IP gewhitelist is, is de sandbox bereikbaar op sandbox.outkept.com/graphql.
Dit is IP-whitelisting voor API-toegang. Dat staat los van de whitelisting die je instelt zodat simulaties je gebruikers bereiken, en los van het whitelisten van je eigen IP om je eigen interacties uit je resultaten te houden.
API-toegang blijft beperkt tot de adressen die je registreerde. Dit is een tijdelijke maatregel om het gebruik te beheersen en misbruik te voorkomen. We zijn van plan API-calls in de toekomst zonder whitelisting open te stellen, al ligt daar geen timing voor vast.

​
Autorisatie

De meeste calls vereisen autorisatie. Er zijn twee manieren om die mee te geven:

​
Een API-sleutel aanmaken

1

Open je accountinstellingen

Log in op platform.outkept.com en open Settings via het menu rechtsboven.
2

Maak de token aan

Klik onder Api Token op Create token.
3

Kopieer beide waarden

Je krijgt een API Client ID en een API Key. Kopieer ze voor je de pagina verlaat.
De API-sleutel wordt één keer getoond. Verlaat je de pagina, dan is ze verborgen en kun je ze niet meer opvragen. Bewaar ze veilig en deel ze nooit.
Klik je opnieuw op Create token, dan wordt de sleutel vernieuwd. De vorige sleutel werkt dan niet meer, dus pas alles aan wat ze gebruikt.

​
Een call autoriseren

Geef je gegevens mee in de Authorization-header van elke GraphQL-request, in de vorm apiClientId:apiKey.
In Apollo Sandbox stel je dit per operatie in:
1

Open het tabblad Headers

Ga onder je operatie naar het tabblad Headers.
2

Voeg de header toe

Voeg een header toe met de naam Authorization.
3

Vul je gegevens in

Zet als waarde je client ID en sleutel, gescheiden door een dubbele punt.
Je kunt nu geautoriseerde calls doen.

​
Apollo Sandbox

In de sandbox op sandbox.outkept.com/graphql verken je de calls die voor jou beschikbaar zijn. Ze documenteert de queries, velden en interfaces terwijl je erdoor navigeert, en is daarmee de meest volledige referentie die we publiceren. Voor de werking van de sandbox zelf, zie de Apollo Sandbox-documentatie.

​
Een operatie omzetten naar cURL

Werkt een operatie in de sandbox, dan kun je ze meenemen naar je eigen shell.
1

Open het operatiemenu

Klik op de drie puntjes naast de operatie.
2

Kopieer ze

Kies Copy operation to cURL.
Het gekopieerde commando bevat alle headers die de operatie had, inclusief je Authorization-header. Behandel het als een geheim voor je het ergens deelt.

​
Contact

Voor problemen of vragen over de API, contacteer support@outkept.com. Wil je bespreken wat je wilt bouwen, schrijf dan naar lead.development@outkept.com.