Passer au contenu principal
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.
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.
Dites-nous ce que vous cherchez à faire à 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.
1

Introduisez une demande

Introduisez une demande de mise en liste blanche d’IP via Jira Support. Vous pouvez demander plusieurs adresses IP en une fois.
2

Attendez la confirmation

Une fois votre IP en liste blanche, le sandbox devient accessible sur sandbox.outkept.com/graphql.
Il s’agit ici de liste blanche d’IP pour l’accès à l’API. Cela n’a rien à voir avec la 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 pour garder vos propres interactions hors de vos résultats.
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 :

​
Créer une clé d’API

1

Ouvrez les paramètres de votre compte

Connectez-vous sur platform.outkept.com et ouvrez Settings depuis le menu en haut à droite.
2

Créez le jeton

Sous Api Token, cliquez sur Create token.
3

Copiez les deux valeurs

Vous recevez un API Client ID et une API Key. Copiez-les avant de quitter la page.
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.
Cliquer à nouveau sur Create token renouvelle la clé. La clé précédente cesse alors de fonctionner : mettez à jour tout ce qui l’utilise.

​
Autoriser une requête

Incluez vos identifiants dans l’en-tête Authorization de chaque requête GraphQL, au format apiClientId:apiKey.
Dans Apollo Sandbox, cela se règle par opération :
1

Ouvrez l'onglet Headers

Sous votre opération, passez à l’onglet Headers.
2

Ajoutez l'en-tête

Ajoutez un en-tête nommé Authorization.
3

Saisissez vos identifiants

Donnez comme valeur votre client ID et votre clé, séparés par deux points.
Vous pouvez à présent effectuer des appels autorisés.

​
Apollo Sandbox

Le sandbox sur 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.

​
Convertir une opération en cURL

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

Ouvrez le menu de l'opération

Cliquez sur les trois points à côté de l’opération.
2

Copiez-la

Choisissez Copy operation to cURL.
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é.

​
Contact

Pour tout problème ou question sur l’API, contactez support@outkept.com. Pour discuter de ce que vous cherchez à construire, écrivez à lead.development@outkept.com.