Aller au contenu

FAQ de l'API Blockchain pour développeurs

Cette FAQ répond aux questions que les développeurs posent le plus souvent sur l’API Chaingateway : authentification, réseaux disponibles, tests, forme des erreurs et obtention d’aide. Chaingateway est une API REST pour créer des wallets, envoyer des transactions, lire des données blockchain et recevoir des webhooks. Chaque réponse renvoie vers la page détaillée.

Quand une requête échoue : lisez le champ ok et le statut dans le corps JSON, puis message et errors, corrigez la requête ou contactez le support si la cause vient du serveur Envoyer la requête Authorization: Bearer YOUR_API_KEY Lire ok et status dans le corps JSON ok: true signifie que l'appel a fonctionné ok: false ? Lire message et errors 401 token ou mot de passe, 422 validation oufonds Corriger la requête ou contacter lesupport support@chaingateway.io
La boucle de traitement des erreurs décrite dans les réponses ci-dessous.

Créez un compte, générez une clé API dans le dashboard et envoyez-la comme token Bearer. L’essai gratuit de 7 jours ne demande pas de carte bancaire. Le démarrage rapide détaille la première requête.

Qu’est-ce que Chaingateway.io ? Chaingateway.io est une plateforme fournissant des solutions d’API blockchain qui permettent aux développeurs d’intégrer des fonctionnalités blockchain dans leurs applications. Une seule interface REST couvre les wallets, les transactions, les soldes, les blocs et les webhooks sur plusieurs réseaux blockchain.

Comment démarrer avec Chaingateway.io ? Pour commencer, créez un compte sur Chaingateway.io. Une fois inscrit, vous pouvez créer une clé API dans le dashboard, sous « API tokens ». Vous en avez besoin pour authentifier vos requêtes API. La documentation propose des guides et des exemples pour vous aider à intégrer l’API dans votre application.

Comment authentifier mes requêtes API ? Les requêtes API vers Chaingateway.io doivent être authentifiées avec une clé API. Créez la clé dans le dashboard après connexion. Envoyez-la comme token Bearer dans les en-têtes de vos requêtes HTTP :

Authorization: Bearer YOUR_API_KEY

Une requête sans token valide renvoie HTTP 401 avec le corps {"message":"Unauthenticated."}. Ne placez pas la clé dans du code côté client ni dans un dépôt.

Existe-t-il des limites d’utilisation pour les API ? Oui, il existe des limites d’utilisation selon votre plan d’abonnement. Les plans supérieurs offrent des quotas plus élevés. Les détails sur les limites et les tarifs figurent sur notre page de tarifs. Par exemple, créer plus d’adresses que votre plan ne le permet renvoie le statut 422 avec le message Your address limit exceeded. Please upgrade your plan.

L’API prend en charge sept blockchains, chacune avec un mainnet et un testnet, et propose sur chacune la gestion des wallets, le traitement des transactions, les webhooks et la récupération de données. Réseaux pris en charge liste les réseaux et les valeurs de l’en-tête X-Network.

Quels réseaux blockchain sont pris en charge ? Chaingateway.io prend en charge les réseaux blockchain suivants :

  • Ethereum (mainnet et Sepolia)
  • Binance Smart Chain (mainnet et testnet)
  • Bitcoin (mainnet et testnet3)
  • Polygon (mainnet et Amoy)
  • Tron (mainnet et Nile)
  • Arbitrum (mainnet et Arbitrum Sepolia)
  • Solana (mainnet et devnet)

Pour plus d’informations sur l’accès aux différents réseaux, consultez Réseaux pris en charge.

Quels types d’API Chaingateway.io propose-t-il ? L’API couvre ces domaines :

  • Gestion des wallets : créer et gérer des wallets.
  • Gestion des transactions : envoyer des coins natifs et des tokens, et lire des transactions.
  • Instant Payment Notification : recevoir des notifications webhook sur les événements blockchain.
  • Récupération de données : obtenir des données blockchain comme les soldes, les blocs et les prix de marché.

Le fichier OpenAPI répertorie plus de 200 opérations. La référence API documente chacune d’elles.

Puis-je tester les API dans un environnement sandbox ? Oui, chaque blockchain prise en charge dispose d’un testnet. Ajoutez l’en-tête X-Network: testnet à une requête pour l’exécuter sur le réseau de test. Sans l’en-tête, ou avec X-Network: mainnet, la requête s’exécute sur le réseau principal. Vous pouvez ainsi tester votre intégration sans déplacer de fonds réels.

Consultez Réseaux pris en charge pour savoir comment accéder aux différents réseaux.

Comment gérer les erreurs et les échecs de webhook ?

Section intitulée « Comment gérer les erreurs et les échecs de webhook ? »

Vérifiez le champ ok de chaque réponse, et journalisez message et errors lorsqu’il vaut false. Les livraisons de webhook qui échouent ne sont pas rejouées automatiquement. Vous les listez et les renvoyez vous-même.

Comment gérer les erreurs de l’API ? Si une requête API échoue, la réponse inclut un statut et un message qui indiquent le problème. Le fichier OpenAPI documente ces codes de statut :

  • 400 : Bad Request. Exemple : le contrat TRC20 n’a pas pu être lu.
  • 401 : Unauthorized. La clé API est invalide ou manquante, ou le mot de passe du wallet est incorrect.
  • 404 : Not Found. Exemple : un identifiant de webhook inexistant.
  • 422 : Unprocessable Entity. La requête était bien formée, mais la validation a échoué ou la blockchain a rejeté la transaction, par exemple pour fonds insuffisants.

Consultez la section de gestion des erreurs de notre documentation pour plus de détails. Nous ajoutons également des informations utiles dans le corps de la réponse. Voici un exemple :

{
"status": 422,
"ok": false,
"message": "insufficient funds for gas * price + value: balance 2000000000000, tx cost 195000000000000, overshot 193000000000000",
"errors": []
}
{
"status": 422,
"ok": false,
"message": "Data validation failed",
"errors": {
"password": ["The password field is required."]
}
}

Comment être notifié des paiements entrants ? Créez un webhook avec POST /api/v2/{chain}/webhooks. Chaingateway envoie ensuite une requête HTTP POST à votre URL pour chaque transaction correspondante. Des webhooks existent pour Ethereum, BNB Smart Chain, Polygon, Arbitrum, TRON et Bitcoin, mais pas pour Solana.

Une livraison échouée n’est pas rejouée automatiquement. Listez les notifications échouées avec GET /api/v2/{chain}/webhooks/notifications/failed et renvoyez-en une avec POST /api/v2/{chain}/webhooks/notifications/{id}/retry. Voir Webhooks et Sécurité des webhooks.

Quel type de wallet utiliser ? Utilisez un wallet protégé par mot de passe pour les adresses de longue durée. Vous envoyez un password lors de la création de l’adresse, et les transactions suivantes sont signées avec ce mot de passe. N’utilisez un wallet non sécurisé que pour des adresses temporaires, car la clé privée est renvoyée dans la réponse et vous devez la stocker. Chaingateway ne stocke pas les mots de passe et ne peut pas restaurer un mot de passe perdu. Voir Gestion des wallets.

Où surveiller l’utilisation et obtenir de l’aide ?

Section intitulée « Où surveiller l’utilisation et obtenir de l’aide ? »

Comment puis-je surveiller mon utilisation de l’API ? Vous pouvez surveiller votre utilisation de l’API depuis le dashboard, qui fournit des analyses et des rapports sur le nombre de requêtes effectuées, l’utilisation des données et les erreurs rencontrées.

Comment obtenir de l’aide en cas de problème ? Pour obtenir de l’aide, vous pouvez nous contacter via le portail d’assistance disponible dans le dashboard. Nous proposons également un forum communautaire et une documentation détaillée qui peuvent aider à résoudre les problèmes courants.

Pour les demandes urgentes, contactez directement notre équipe support par e-mail à support@chaingateway.io, via Telegram, ou via le chat web sur le site.

Nous animons également une communauté Telegram où vous trouverez des discussions utiles.

Existe-t-il un programme de parrainage ou de partenariat ? Oui, nous proposons des programmes de parrainage et de partenariat pour les développeurs et les entreprises souhaitant promouvoir Chaingateway.io. Pour plus d’informations, consultez notre page partenaires.

Où puis-je trouver les dernières actualités et mises à jour sur Chaingateway.io ?

Restez informé des dernières actualités, sorties de fonctionnalités et annonces en suivant notre blog et en vous abonnant à notre newsletter.