Aller au contenu principal

Comment utiliser l'API ?

L'API est sécurisée par une clé API pour Hero Cash.

Si vous n'avez pas encore de clé API, vous pouvez suivre ce guide.

Sécurité

Votre clé API est une information sensible, vous devez la garder secrète et en sécurité !

Point d'accès de l'API​

Notre API est disponible sur deux environnements différents :

  • Production : https://api.hero.fr/api/graphql
  • Staging : https://staging.api.hero.fr/api/graphql

Utilisez l'environnement de staging pour faire des tests (aucun transfert d'argent ne sera effectué sur cet environnement), mais n'oubliez pas d'utiliser le point d'accès de Production dans votre environnement de production !

Graphql​

Vous avez peut-être remarqué, nous n'utilisons pas REST, mais nous nous appuyons sur GraphQL pour notre API.

GraphQL transite par HTTP, vous n'avez donc pas besoin de connaître GraphQL pour utiliser notre API, mais il y a quelques différences à connaître :

  • GraphQL n'utilise pas les statuts HTTP. Vous devez vérifier les données que nous vous envoyons pour vous assurer qu'il n'y a pas d'erreurs.
  • Avec GraphQL, vous pouvez choisir chaque élément de données que vous souhaitez recevoir.
  • GraphQL est typé, ce qui permet d'avoir des résultats d'API prévisibles.

Limitation de débit​

Avertissement

Tous les points d'accès de notre plateforme sont soumis à des limites de débit. Si vous dépassez la limite de débit, vous recevrez un code d'état HTTP 429.

Vous pouvez effectuer jusqu'à 1800 requêtes par minute et 200 requêtes par seconde.

De plus, certaines opérations peuvent prendre du temps à traiter en raison de la récupération des données. Si vous prévoyez d'utiliser des opérations en masse, il est recommandé de minimiser la taille des lots et d'augmenter le nombre d'appels pour avoir un temps de réponse plus rapide.

Faisons un appel​

GraphQL transite via HTTP, c'est donc fondamentalement une simple requête comme :

curl -X POST \
-H "Content-Type: application/json" \
-H "Authorization: Api-Key <Votre-Clé-Api>" \
-d '{"query": "{ version }"}' \
https://staging.api.hero.fr/api/graphql