Aller au contenu

Démarrage rapide et clés API Blockchain

L’API Chaingateway est une API REST qui crée des wallets, envoie des transactions, lit des soldes et délivre des webhooks pour plusieurs blockchains via HTTPS et JSON. Pour l’appeler, il vous faut un compte, un token API et un client HTTP. Ce guide couvre les trois et se termine par une première requête qui crée une adresse Ethereum.

Flux d'une requête : votre application envoie une requête HTTPS avec un token Bearer et un en-tête X-Network optionnel à l'API Chaingateway, qui interroge la blockchain et répond en JSON Votre application Client HTTP : curl, requests, axios, Guzzle Requête HTTPS versapp.chaingateway.io/api/v2/{chain}/... Authorization: Bearer token, X-Network:testnet optionnel API Chaingateway valide le token et le corps, dialogue avec lablockchain Réponse JSON status, ok, message, data
Ce qui se passe à chaque appel de l'API.

Créez un compte, ouvrez la page des clés API et générez un token. Un nouveau compte démarre avec un essai gratuit de 7 jours, sans carte bancaire. Créez votre compte Chaingateway ou connectez-vous, puis ouvrez la page des clés API.

Saisissez un nom pour le token et cliquez sur « + Create Token ». Le nouveau token apparaît dans la liste. Conservez-le en lieu sûr et ne le communiquez à personne. Toute personne qui détient le token peut appeler l’API avec votre compte : gardez-le hors du gestionnaire de versions et chargez-le depuis une variable d’environnement ou un fichier .env.

Tout client capable d’envoyer des requêtes HTTPS convient. La référence API génère des exemples pour beaucoup plus de langages que cette page. Les exemples ci-dessous utilisent ces clients :

L’API suit la sémantique des méthodes HTTP définie dans la RFC 9110. Les ressources comme addresses, transactions et webhooks se trouvent sous /api/v2/{chain}/, et la méthode indique ce qui arrive à la ressource. Les réponses sont au format JSON.

MéthodeSignificationExemple dans cette API
GETLire une ressource ou une listeGET /api/v2/ethereum/addresses liste vos adresses
POSTCréer une ressource ou déclencher une actionPOST /api/v2/ethereum/addresses crée une adresse
PUTRemplacer les champs d’une ressource existantePUT /api/v2/ethereum/webhooks/{id} met à jour un webhook
DELETESupprimer une ressourceDELETE /api/v2/ethereum/addresses/{address} supprime une adresse

Une adresse ne peut pas être modifiée, car ses clés la définissent : il n’existe donc ni PUT ni PATCH pour les adresses. Le mot de passe d’une clé stockée fait exception et se modifie via POST /api/v2/{chain}/addresses/{address}.

De quels en-têtes chaque requête a-t-elle besoin ?

Section intitulée « De quels en-têtes chaque requête a-t-elle besoin ? »

Envoyez trois en-têtes : Authorization, Accept et, lorsque la requête a un corps, Content-Type. Un quatrième en-tête optionnel, X-Network, sélectionne le réseau de test.

  • Authorization: Bearer YOUR_API_TOKEN transporte votre token en tant que token Bearer, comme défini dans la RFC 6750. Une requête sans token valide reçoit HTTP 401 et le corps {"message":"Unauthenticated."}.
  • Accept: application/json demande une réponse JSON.
  • Content-Type: application/json indique au serveur que le corps de la requête est du JSON. L’API accepte aussi les corps encodés en formulaire, mais les exemples utilisent du JSON.
  • X-Network: testnet exécute la requête sur le réseau de test. Omettez l’en-tête, ou envoyez mainnet, pour le réseau principal. Le tableau des réseaux liste les réseaux associés à chaque valeur.

Créez une adresse Ethereum avec une requête POST. Le corps est un objet JSON avec un seul champ, password. Il protège la clé privée que Chaingateway stocke pour cette adresse, et vous en avez de nouveau besoin à chaque transaction envoyée depuis l’adresse. Gestion des wallets explique ce qui se passe si vous l’omettez.

Fenêtre de terminal
curl --request POST \
--url https://app.chaingateway.io/api/v2/ethereum/addresses \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Accept: application/json' \
--header 'Content-Type: application/json' \
--data '{
"password": "choose-a-strong-password"
}'

Un appel réussi renvoie le statut 201. Le fichier OpenAPI écrit la clé du champ d’adresse adderess : lisez-la sous ce nom.

{
"status": 201,
"ok": true,
"message": "Address created",
"data": {
"adderess": "0x7d3bC832A0860fD882FF4C2359e10268f4E5CCf8"
}
}

Pour lire des données, utilisez GET, qui n’a pas de corps de requête. L’appel suivant liste les adresses que vous avez créées et pas encore supprimées.

Fenêtre de terminal
curl --request GET \
--url https://app.chaingateway.io/api/v2/ethereum/addresses \
--header 'Authorization: Bearer YOUR_API_TOKEN' \
--header 'Accept: application/json'

Ajoutez l’en-tête X-Network: testnet et gardez tout le reste. L’adresse est alors créée sur Sepolia, et les coins de test n’ont aucune valeur de marché. Utilisez le testnet jusqu’à ce que votre intégration gère correctement les réponses de succès et d’erreur. Pour passer plus tard au réseau principal, retirez l’en-tête ou réglez-le sur mainnet.

Les erreurs utilisent la même enveloppe JSON que les appels réussis, avec ok à false. Le fichier OpenAPI documente les codes de statut 200, 201, 400, 401, 404 et 422. Une erreur de validation liste les champs rejetés :

{
"status": 422,
"ok": false,
"message": "Data validation failed",
"errors": {
"password": ["The password field is required."]
}
}

Les erreurs blockchain arrivent de la même façon. Une transaction sans solde suffisant pour le gas renvoie 422 avec le message du nœud, et un mauvais mot de passe de wallet renvoie 401 avec Wrong password provided. Journalisez message et errors à chaque appel échoué, car ils nomment en général le champ ou la cause.