Cas d'usage d'une API blockchain : six exemples
Six cas d'usage d'une API blockchain et leurs points de terminaison Chaingateway : paiements, versements, portefeuilles, surveillance, consultation, NFT.
Relu par Maurice Sobiera
Une API blockchain est un service web qui permet à une application de créer des adresses, de lire des soldes, d’envoyer des transactions et de recevoir des notifications via HTTPS, sans faire tourner de nœuds blockchain. Elle encapsule l’interface bas niveau des nœuds, généralement JSON-RPC, dans un ensemble d’appels plus réduit. Les cas d’usage ci-dessous montrent les appels dont chacun a besoin.
À quoi sert une API blockchain ?
Les usages courants se ramènent à six tâches. Chacune correspond à quelques points de terminaison de l’API REST de Chaingateway, et le même schéma existe sur chaque réseau pris en charge, sauf mention contraire.
| Cas d’usage | Ce que fait l’application | Principaux points de terminaison (Ethereum) |
|---|---|---|
| Accepter des paiements crypto | Créer une adresse de dépôt par commande et attendre le paiement | POST /addresses, POST /webhooks, GET /balances/{address} |
| Verser ou distribuer des tokens | Envoyer de la monnaie native ou des tokens à de nombreuses adresses | POST /transactions, POST /transactions/erc20 |
| Faire tourner un backend de portefeuille | Créer, importer et exporter des adresses | POST /addresses, POST /addresses/import, GET /addresses/export/{address} |
| Surveiller des adresses | Réagir aux transferts entrants et sortants | POST /webhooks, GET /webhooks/notifications |
| Consulter les données de la chaîne | Lire les blocs, les transactions et les reçus | GET /blocks/{block_number}, GET /transactions/{txid} |
| Vérifier des NFT | Lire le propriétaire et l’URI de métadonnées d’un token | GET /nfts/{contract_address}/owner/{token_id} |
Tous les chemins commencent par /api/v2/{blockchain}, par exemple /api/v2/ethereum/addresses. La liste complète figure dans la référence de l’API.
Comment accepter des paiements crypto avec une API ?
Créez une adresse de dépôt pour chaque commande, enregistrez un webhook pour cette adresse, et considérez le webhook comme le signal qu’un paiement est arrivé. L’appel d’adresse renvoie une nouvelle adresse. L’appel de webhook prend l’adresse (to), une url et un type comme ETH, ERC20 ou ERC721, ainsi qu’une reference facultative de 255 caractères au plus, que vous pouvez utiliser comme identifiant de commande.
# 1. Create a password-protected deposit addresscurl -X POST https://app.chaingateway.io/api/v2/ethereum/addresses \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{"password": "a-long-random-password"}'
# 2. Watch it for incoming ERC-20 transferscurl -X POST https://app.chaingateway.io/api/v2/ethereum/webhooks \ -H "Authorization: Bearer YOUR_API_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "to": "0xDepositAddressFromStep1", "contractaddress": "0xTokenContractAddress", "type": "ERC20", "url": "https://shop.example.com/hooks/chaingateway", "reference": "order-10231" }'Lorsqu’un transfert correspondant apparaît, Chaingateway envoie une notification à votre URL. Vérifiez son en-tête X-Signature, puis confirmez le montant sur la chaîne avant de libérer les marchandises. Les webhooks ne sont pas relancés automatiquement : les notifications en échec sont listées sous /webhooks/notifications/failed et peuvent être renvoyées. Solana ne propose pas de webhooks, interrogez donc plutôt le point de terminaison de solde. Notre guide des webhooks de paiement couvre l’ensemble du flux.
Comment envoyer des versements ou des distributions ?
Appelez le point de terminaison de transaction une fois par destinataire, depuis un script. Pour les tokens, utilisez POST /api/v2/ethereum/transactions/erc20 avec l’expéditeur, l’adresse du contrat, le destinataire et le montant.
Chaque transfert nécessite du gas dans la monnaie native du réseau sur l’adresse expéditrice. Vérifiez GET /gasprice avant un gros lot, et envoyez les transferts en séquence pour chaque adresse expéditrice afin que les nonces n’entrent pas en collision. Les transferts de NFT utilisent le point de terminaison erc721, décrit dans Transférer des NFT via l’API.
Une API peut-elle faire tourner un backend de portefeuille ?
Oui, dans certaines limites. Les points de terminaison d’adresse créent des adresses, et un paramètre password conserve la clé privée chiffrée sur le serveur, de sorte que vous pouvez envoyer avec le mot de passe au lieu de la clé. Vous pouvez importer une adresse existante, puis exporter une clé privée plus tard. Le guide de gestion des portefeuilles présente les compromis, et nos conseils de sécurité expliquent pourquoi les fonds à long terme doivent être conservés hors ligne.
Les soldes proviennent de GET /balances/{address} pour la monnaie native, et de GET /balances/{address}/erc20 pour les tokens. Le point de terminaison de liste des transactions n’affiche que les transactions créées via l’API Chaingateway. Il n’indexe pas toutes les transactions d’une adresse : utilisez donc les webhooks si vous avez aussi besoin des transferts entrants.
Comment surveiller des adresses et consulter les données de la chaîne ?
Utilisez les webhooks pour les événements, et les points de terminaison de consultation pour l’historique. Les webhooks couvrent les adresses et contrats que vous enregistrez. Pour le reste, lisez un bloc par numéro, une transaction par hash ou une transaction décodée. Bitcoin dispose de ses propres points de terminaison basés sur les portefeuilles, sous /api/v2/bitcoin. Si vous avez besoin d’un accès brut au nœud plutôt que de ces appels, les méthodes sont documentées dans la référence JSON-RPC d’Ethereum et la référence RPC de Bitcoin.
Quels réseaux prennent en charge quel cas d’usage ?
La prise en charge varie selon le réseau, comme le montre le fichier OpenAPI. Consultez ce tableau avant de concevoir autour d’une fonctionnalité.
| Réseau | Webhooks | Transferts de tokens | Propriétaire et URI d’un NFT | Modèle de portefeuille |
|---|---|---|---|---|
| Ethereum, Polygon, Arbitrum | Oui | ERC-20 et ERC-721 | Oui | Adresses uniques |
| BNB Smart Chain | Oui | BEP-20 et BEP-721 | Oui | Adresses uniques |
| TRON | Oui | TRC-20 et TRC-721 | Non, pas de point de terminaison de consultation | Adresses uniques |
| Solana | Non | SPL | Oui | Adresses uniques |
| Bitcoin | Oui | Monnaie native uniquement | Sans objet | Portefeuilles qui détiennent des adresses |
Un flux de paiement qui repose sur les webhooks a donc besoin d’un mécanisme d’interrogation de secours sur Solana. Un flux qui repose sur la vérification de propriété de NFT a besoin d’une autre source de données sur TRON.
Comment essayer un cas d’usage sans fonds réels ?
Exécutez-le d’abord sur un réseau de test. Ajoutez l’en-tête X-Network: testnet à n’importe quelle requête, et le même point de terminaison fonctionne sur le réseau de test au lieu du mainnet. Omettez l’en-tête, ou réglez-le sur mainnet, pour revenir en arrière. Vous pouvez ainsi tester la création d’adresse, un transfert et un aller-retour de webhook, y compris la vérification de la signature, avant qu’une valeur réelle ne soit en jeu.
Chaingateway propose un essai gratuit de 7 jours sans carte, et vous n’avez pas besoin de vérification d’identité pour commencer. Les étapes sont courtes :
- Créez un compte et copiez votre token API depuis le tableau de bord.
- Créez une adresse de test et approvisionnez-la via un robinet (faucet) public du réseau de test choisi.
- Enregistrez un webhook pointant vers une URL publique de votre récepteur.
- Envoyez un transfert de test, et vérifiez que la notification arrive et que sa signature est valide.
Notre guide de démarrage rapide reprend la même séquence avec des exemples de code.
Quels cas d’usage ne conviennent pas ?
Une API de ce type ne convient pas aux travaux qui nécessitent l’historique complet de la chaîne pour des adresses quelconques, comme l’analyse de données, la déclaration fiscale ou les décisions de prêt. Ces tâches exigent un indexeur qui stocke chaque transaction, et non un service qui envoie des transactions et vous notifie au sujet des adresses que vous avez enregistrées. Construisez ou achetez cette partie séparément, et utilisez l’API pour l’envoi des transactions et les notifications.
Comment nous rédigeons ces articles
Prêt à le construire vous-même ? Obtenir votre clé API — essai de 7 jours, sans carte bancaire — ou consultez API Blockchain pour la référence complète des endpoints.