Aller au contenu principal

Se connecter à l'api

remarque

Tout les appels à l'api doivent être fait avec une tracking key, fournie par votre organisation. Vous pouvez vous réfé rer à "Comment créer une clé d'api" pour plus d'informations.

Une fois la clé et le secret en poche, il vous faut vous connecter à l'api. L'api fonctionne par jetons, vous devez donc en récupérer un.

Fonctionnement de l'api​

L'api fonctionne par jetons, vous devez donc en récupérer un pour commencer à utiliser l'api. Pour cela, vous devez envoyer une requête de connexion une seule fois pour récupérer un jeton puis vous pourrez l'utiliser pour les autres requêtes.

Récupérer un jeton d'api​

Pour récupérer un jeton d'api il vous suffit de vous connecter à l'api !

Pour cela, vous devez envoyer une requête POST à l'adresse /auth/connect.

Données de la requête:

  • method (string): La méthode d'authentification. Doit être "api-key".
  • key (string): La clé API utilisée pour l'authentification.
  • secret (string): Le secret associé à la clé API.

Exemple de requête:

{
"method": "api-key",
"key": "WOOCH_SIMDE_KEY",
"secret": "WOOCH_SIMDE_KEY_SECRET"
}

Réponse:

  • access_token (string): Le token d'accès généré après une authentification réussie.

Exemple de réponse:

{
"auth": {
"access_token": "votre_token_d_acces"
},
"key": {
... key details
}
}