> ## Documentation Index
> Fetch the complete documentation index at: https://docs.outkept.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API

> Een GraphQL API, met een Apollo Sandbox om ze te verkennen.

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.

<Warning>
  We bouwen geen maatwerkoplossingen bovenop de API. Heb je uitgebreidere ondersteuning nodig,
  dan raden we aan om met een van onze partners te werken.
</Warning>

Laat ons weten wat je wilt bereiken via
[lead.development@outkept.com](mailto: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.

<Steps>
  <Step title="Dien een aanvraag in">
    Dien een aanvraag voor IP-whitelisting in via
    [Jira Support](https://outkept.atlassian.net/servicedesk/customer/portal/1/group/1/create/13).
    Je kunt meerdere IP-adressen in één keer aanvragen.
  </Step>

  <Step title="Wacht op bevestiging">
    Zodra je IP gewhitelist is, is de sandbox bereikbaar op
    [sandbox.outkept.com/graphql](https://sandbox.outkept.com/graphql).
  </Step>
</Steps>

<Note>
  Dit is IP-whitelisting voor API-toegang. Dat staat los van de
  [whitelisting](/nl/whitelisting) die je instelt zodat simulaties je gebruikers bereiken, en
  los van het [whitelisten van je eigen IP](/nl/whitelisting-your-ip) om je eigen interacties
  uit je resultaten te houden.
</Note>

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:

| Methode | Opmerkingen |
| - | - |
| API-sleutel | De voorkeursmethode, en degene die hier beschreven staat |
| Login-call | Stuur je gebruikersnaam en wachtwoord op om een responstoken te krijgen |

### Een API-sleutel aanmaken

<Steps>
  <Step title="Open je accountinstellingen">
    Log in op [platform.outkept.com](https://platform.outkept.com/) en open **Settings** via
    het menu rechtsboven.
  </Step>

  <Step title="Maak de token aan">
    Klik onder **Api Token** op **Create token**.
  </Step>

  <Step title="Kopieer beide waarden">
    Je krijgt een **API Client ID** en een **API Key**. Kopieer ze voor je de pagina verlaat.
  </Step>
</Steps>

<Warning>
  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.
</Warning>

<Note>
  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.
</Note>

### Een call autoriseren

Geef je gegevens mee in de `Authorization`-header van elke GraphQL-request, in de vorm
`apiClientId:apiKey`.

```
Authorization: <apiClientId>:<apiKey>
```

In Apollo Sandbox stel je dit per operatie in:

<Steps>
  <Step title="Open het tabblad Headers">
    Ga onder je operatie naar het tabblad **Headers**.
  </Step>

  <Step title="Voeg de header toe">
    Voeg een header toe met de naam `Authorization`.
  </Step>

  <Step title="Vul je gegevens in">
    Zet als waarde je client ID en sleutel, gescheiden door een dubbele punt.
  </Step>
</Steps>

Je kunt nu geautoriseerde calls doen.

## Apollo Sandbox

In de sandbox op [sandbox.outkept.com/graphql](https://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](https://www.apollographql.com/docs/apollo-sandbox).

### Een operatie omzetten naar cURL

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

<Steps>
  <Step title="Open het operatiemenu">
    Klik op de drie puntjes naast de operatie.
  </Step>

  <Step title="Kopieer ze">
    Kies **Copy operation to cURL**.
  </Step>
</Steps>

<Note>
  Het gekopieerde commando bevat alle headers die de operatie had, inclusief je
  `Authorization`-header. Behandel het als een geheim voor je het ergens deelt.
</Note>

## Contact

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


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.