> ## 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

> Une API GraphQL, avec un Apollo Sandbox pour l'explorer.

Tous nos appels d'API reposent sur GraphQL, et notre API publique suit la même norme. La
documentation écrite est limitée : nous fournissons donc un environnement Apollo Sandbox où
vous pouvez expérimenter les appels directement. Le sandbox contient des explications sur les
requêtes, les champs et les interfaces disponibles.

<Warning>
  Nous ne développons pas de solutions sur mesure au-dessus de l'API. Si vous avez besoin d'un
  accompagnement plus poussé, nous vous recommandons de travailler avec l'un de nos
  partenaires.
</Warning>

Dites-nous ce que vous cherchez à faire à
[lead.development@outkept.com](mailto:lead.development@outkept.com) et nous vous orienterons.

## Demander l'accès

L'accès à l'API et au sandbox est réservé aux adresses IP mises en liste blanche. Avant de
pouvoir faire le moindre appel, demandez la mise en liste blanche de la ou des IP depuis
lesquelles vous vous connecterez.

<Steps>
  <Step title="Introduisez une demande">
    Introduisez une demande de mise en liste blanche d'IP via
    [Jira Support](https://outkept.atlassian.net/servicedesk/customer/portal/1/group/1/create/13).
    Vous pouvez demander plusieurs adresses IP en une fois.
  </Step>

  <Step title="Attendez la confirmation">
    Une fois votre IP en liste blanche, le sandbox devient accessible sur
    [sandbox.outkept.com/graphql](https://sandbox.outkept.com/graphql).
  </Step>
</Steps>

<Note>
  Il s'agit ici de liste blanche d'IP pour l'accès à l'API. Cela n'a rien à voir avec la
  [liste blanche](/fr/liste-blanche) que vous mettez en place pour que les simulations
  parviennent à vos utilisateurs, ni avec le fait de
  [mettre votre propre IP en liste blanche](/fr/liste-blanche-votre-ip) pour garder vos propres
  interactions hors de vos résultats.
</Note>

L'accès à l'API reste limité aux adresses que vous avez enregistrées. C'est une mesure
temporaire, destinée à maîtriser l'usage et à prévenir les abus. Nous prévoyons d'ouvrir les
appels d'API sans liste blanche à l'avenir, sans calendrier arrêté.

## Autorisation

La plupart des appels exigent une autorisation. Il y a deux façons de la fournir :

| Méthode | Remarques |
| - | - |
| Clé d'API | La méthode recommandée, et celle décrite ici |
| Appel de connexion | Envoyez votre nom d'utilisateur et votre mot de passe pour obtenir un jeton de réponse |

### Créer une clé d'API

<Steps>
  <Step title="Ouvrez les paramètres de votre compte">
    Connectez-vous sur [platform.outkept.com](https://platform.outkept.com/) et ouvrez
    **Settings** depuis le menu en haut à droite.
  </Step>

  <Step title="Créez le jeton">
    Sous **Api Token**, cliquez sur **Create token**.
  </Step>

  <Step title="Copiez les deux valeurs">
    Vous recevez un **API Client ID** et une **API Key**. Copiez-les avant de quitter la page.
  </Step>
</Steps>

<Warning>
  La clé d'API n'est affichée qu'une seule fois. Si vous quittez la page, elle est masquée et
  ne peut plus être récupérée. Conservez-la en lieu sûr et ne la partagez jamais.
</Warning>

<Note>
  Cliquer à nouveau sur **Create token** renouvelle la clé. La clé précédente cesse alors de
  fonctionner : mettez à jour tout ce qui l'utilise.
</Note>

### Autoriser une requête

Incluez vos identifiants dans l'en-tête `Authorization` de chaque requête GraphQL, au format
`apiClientId:apiKey`.

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

Dans Apollo Sandbox, cela se règle par opération :

<Steps>
  <Step title="Ouvrez l'onglet Headers">
    Sous votre opération, passez à l'onglet **Headers**.
  </Step>

  <Step title="Ajoutez l'en-tête">
    Ajoutez un en-tête nommé `Authorization`.
  </Step>

  <Step title="Saisissez vos identifiants">
    Donnez comme valeur votre client ID et votre clé, séparés par deux points.
  </Step>
</Steps>

Vous pouvez à présent effectuer des appels autorisés.

## Apollo Sandbox

Le sandbox sur [sandbox.outkept.com/graphql](https://sandbox.outkept.com/graphql) est l'endroit
où vous explorez les appels qui vous sont accessibles. Il documente les requêtes, les champs et
les interfaces au fil de votre navigation : c'est la référence la plus complète que nous
publions.

Pour le fonctionnement du sandbox lui-même, voir la
[documentation Apollo Sandbox](https://www.apollographql.com/docs/apollo-sandbox).

### Convertir une opération en cURL

Lorsqu'une opération fonctionne dans le sandbox, vous pouvez l'emporter dans votre propre
shell.

<Steps>
  <Step title="Ouvrez le menu de l'opération">
    Cliquez sur les trois points à côté de l'opération.
  </Step>

  <Step title="Copiez-la">
    Choisissez **Copy operation to cURL**.
  </Step>
</Steps>

<Note>
  La commande copiée embarque tous les en-têtes de l'opération, y compris votre en-tête
  `Authorization`. Traitez-la comme un secret avant de la coller où que ce soit de partagé.
</Note>

## Contact

Pour tout problème ou question sur l'API, contactez
[support@outkept.com](mailto:support@outkept.com). Pour discuter de ce que vous cherchez à
construire, écrivez à
[lead.development@outkept.com](mailto:lead.development@outkept.com).


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