Documentation de l'API Dokeop

Accès

Tous les appels à l’API Dokeop nécessitent un access_token (jeton d'accès) définissant l’utilisateur et l'application effectuant l’appel.

Tout utilisateur enregistré sur Dokeop peut obtenir un jeton d'accès. Seuls les utilisateurs "plate-forme d'inscription" peuvent créer une application en se connectant à leur compte (https://developers.dokeop.com/platform/settings/app).

Reportez-vous à la page Authentification pour plus d'informations sur la génération de jetons d'accès et le flow d'autorisation OAuth.

De manière générale, une application d'API Dokeop n’a accès aux données d’un utilisateur que lorsque celui-ci a autorisé l’application à l’utiliser.

API d'évènements Webhook

Dokeop met un disposition un système de Webhook permettant de pousser des informations à une application abonnée aux événements qui se produisent sur Dokeop. Les webhooks permettent aux plates-formes d'inscription de recevoir des mises à jour en temps réel pour certains évènements, éliminant ainsi le besoin d'interroger l'API Dokeop.

Reportez-vous à la page Webhooks pour plus d'informations.

Code client

Pour exécuter Swagger, vous devez avoir un environnement d’exécution Java installé sur votre ordinateur. Pour générer du code client, vous devez d'abord installer Swagger Codegen 2.X. Sur macOS, vous pouvez utiliser Homebrew:

$brew install swagger-codegen@2 maven

Pour générer du code dans une language donné, exécutez swagger-codegen generate avec les paramètres suivants:

Cet exemple générera le code PHP du client pour l'API:

$ swagger-codegen generate -i https://developers.dokeop.com/swagger/swagger.json -l php -o generated/php

Dates

Les dates et heures sont conformes à la norme ISO 8601, sauf indication contraire. Quelque exemples:

Nationalité

Le code nationalité nationality est conforme à la norme ISO_3166-1, sauf indication contraire. Quelque exemples:

Méthodes de requête

L'API Dokeop utilise les verbes HTTP suivants pour chaque action:

Codes de statut

L’API retourne toujours un code HTTP valide. Vous trouverez la liste des retours possible ci-dessous.