Documentation de l'API Dokeop

Authentification

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 "plateforme d'inscription" peuvent créer une application en se connectant à leur compte.

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:

• --input-spec <spec file>: utilisez https://developers.dokeop.com/swagger/swagger.json de l'API Dokeop
• --config <configuration file>: (optionnel) indiquez le fichier de configuration
• --lang <language>: le langage de programmation cible pour lequel vous souhaitez générer du code (exécuter swagger-codegen seul imprimera une liste des langues disponibles)
• --output <output directory>: l'emplacement des fichiers générés

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:

• 2019-06-23T15:46:20Z
• 2019-06-24T09:54:13-07:00

Nationalité

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

• 'FR'
• 'EN'
• 'RU'

Sports

La liste des sports contient l'exhaustivité des codes des sports utilisés sur Dokeop.

Méthodes de requête

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

• HEAD peut être utilisé sur n'importe quelle ressource pour obtenir uniquement les informations d'en-tête
• GET utilisé pour récupérer une resource ou une collection de resources
• POST utilisé pour créer une resource
• PUT utilisé for mettre à jour ou remplacer une resource
• DELETE utilisé pour supprimer une resource

Codes de statut

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

• 200 Requête traitée avec succès
• 201 Ressource créée avec succès
• 204 Ressource mise à jour avec succès (aucun contenu)
• 401 Non autorisé (authentification nécessaire)
• 403 Interdit (droits insuffisants)
• 404 Ressource non trouvée
• 422 Mauvaise requête (paramètre obligatoire manquant ou mauvaise valeur)
• 500 Erreur interne de Dokeop