Documentation de l’API WEEX : comment débuter avec l’API de trading WEEX

Pour débuter avec l’API WEEX, il faut deux choses : la documentation officielle de l’API WEEX et une clé API configurée pour les fonctions que vous souhaitez utiliser. WEEX fournit des ressources API pour le trading au comptant et les contrats à terme USDT-M ; sa documentation couvre les données de marché, les fonctions de compte, les opérations de trading, l’API REST et les connexions WebSocket.

Pour accéder aux données de marché publiques, les développeurs peuvent utiliser les points de terminaison pris en charge sans authentification. Les fonctions privées, notamment la gestion du compte et des ordres, nécessitent une clé API et des requêtes authentifiées.

La configuration est simple : choisissez la documentation WEEX pertinente, créez une clé API, configurez les autorisations nécessaires, sécurisez vos identifiants et connectez votre application au point de terminaison API approprié.

Où trouver la documentation officielle de l’API WEEX ?

WEEX propose une documentation dédiée couvrant les produits et interfaces pris en charge. Elle est mise à jour lorsque les fonctionnalités de l’API évoluent, et les pages consacrées à chaque point de terminaison comprennent des exemples de requêtes et de réponses pour faciliter l’intégration. 

Pour Spot V3, la documentation présente les étapes de préparation, les domaines API, l’authentification, les données de marché, les fonctions de compte, les fonctions liées aux ordres, les connexions WebSocket, les limites de débit et d’autres exigences techniques.

WEEX distingue les interfaces API publiques et privées. Les API publiques permettent de récupérer la configuration et les données de marché sans authentification. Les API privées couvrent des fonctions telles que la gestion des ordres et des comptes et nécessitent des requêtes authentifiées.

Avant l’intégration, les développeurs doivent choisir la documentation correspondant au produit qu’ils prévoient d’utiliser, car les points de terminaison et les exigences techniques peuvent varier entre le marché au comptant et les contrats à terme.

Comment créer une clé API WEEX

Pour utiliser les fonctions privées de l’API WEEX, vous devez d’abord créer une clé API depuis votre compte WEEX. Selon la documentation actuelle de Spot V3, les étapes de base sont les suivantes :

1. Connectez-vous à WEEX sur la plateforme Web.
2. Ouvrez la gestion des API et créez une nouvelle clé API.
3. Configurez les autorisations nécessaires à votre intégration.
4. Associez une adresse IP si cela convient à votre configuration.
5. Enregistrez en lieu sûr les identifiants API générés ou configurés pendant la procédure.

Chaque compte WEEX peut actuellement créer jusqu’à 10 groupes de clés API. Les utilisateurs peuvent ainsi conserver des clés API distinctes pour différentes applications ou configurations de trading, plutôt que d’utiliser une seule clé pour toutes les connexions.

Lors de la création d’une clé API, trois identifiants sont importants : APIKey identifie l’utilisateur de l’API pour l’authentification. SecretKey est la clé privée utilisée pour générer les signatures des requêtes.

Passphrase est définie par l’utilisateur et est nécessaire pour l’accès authentifié. Si la Passphrase est perdue, WEEX indique qu’elle ne peut pas être récupérée et qu’une nouvelle clé API doit être créée. Ces identifiants doivent être conservés en lieu sûr et ne doivent pas être communiqués à d’autres personnes.

Comment configurer les autorisations de l’API WEEX

Une nouvelle clé API Spot WEEX dispose par défaut de l’autorisation Lecture seule. Elle peut ainsi accéder aux fonctions de consultation prises en charge, sans pouvoir effectuer d’opérations de trading au comptant.

Si une application doit passer ou annuler des ordres au comptant, l’autorisation Spot correspondante doit être activée.

L’autorisation appropriée dépend donc des besoins de l’application. Un outil utilisé uniquement pour surveiller les soldes, consulter l’historique de trading ou analyser des informations peut conserver l’accès en lecture seule. Une application conçue pour exécuter des ordres au comptant nécessite l’autorisation de trading Spot.

WEEX permet également d’associer les clés API à des adresses IP. La documentation officielle avertit que les clés API sans restriction et sans association à une adresse IP présentent un risque de sécurité supplémentaire, et recommande d’associer une adresse IP lors de la création d’une clé.

En pratique, il est préférable d’accorder à chaque intégration uniquement les autorisations dont elle a réellement besoin, plutôt que d’activer des accès supplémentaires qu’elle n’utilisera pas.

Comment se connecter à l’API REST WEEX

Une fois votre clé API et ses autorisations configurées, vous pouvez connecter votre application à l’API REST WEEX. WEEX fournit des points de terminaison REST pour les données de marché, les informations de compte et les opérations de trading prises en charge.

Les points de terminaison publics permettent de récupérer des informations de marché sans authentification. Les points de terminaison privés, tels que ceux dédiés aux fonctions de compte et aux ordres, nécessitent une authentification à l’aide de vos identifiants API et doivent respecter les exigences de signature indiquées dans la documentation officielle de l’API WEEX.

Pour commencer, il est conseillé de tester une requête publique de données de marché avant de passer aux fonctions authentifiées. Une fois la connexion établie, vous pouvez utiliser les points de terminaison privés appropriés en fonction des autorisations activées pour votre clé API.

Les points de terminaison API et les exigences techniques pouvant être mis à jour, consultez toujours la dernière documentation de l’API WEEX lors de la configuration de votre intégration.

Comment vérifier votre connexion à l’API WEEX

Pour démarrer une intégration, vous pouvez d’abord vérifier que l’application communique correctement avec l’API WEEX avant d’ajouter des fonctions de trading plus complexes.

Vous pouvez commencer par envoyer des requêtes à l’API publique, car elles ne nécessitent pas d’authentification. Une fois la connexion de base établie, vous pouvez tester les requêtes authentifiées selon les autorisations attribuées à la clé API.

Si une requête authentifiée échoue, plusieurs éléments de la configuration peuvent être à vérifier : les identifiants API, les autorisations, la signature de la requête, l’horodatage, le domaine API et les restrictions d’adresse IP.

WEEX exige que les requêtes authentifiées utilisent une méthode de signature standardisée. Selon la documentation V3 actuelle, l’horodatage de la requête est mesuré en millisecondes et une requête peut être rejetée si son horodatage diffère de plus de 30 secondes de l’heure du serveur API WEEX. 

Tester la connexion étape par étape permet de déterminer plus facilement si le problème vient de la connectivité, de l’authentification, des autorisations ou de la requête elle-même.

Que vérifier avant d’utiliser l’API WEEX pour le trading ?

Avant d’utiliser l’API WEEX pour le trading, vérifiez les autorisations de votre clé API et assurez-vous qu’elle dispose uniquement des accès nécessaires à votre application. WEEX recommande également d’associer les clés API à des adresses IP de confiance et de protéger la clé API, la SecretKey et la Passphrase.

Les développeurs doivent aussi vérifier les limites de débit API en vigueur et gérer correctement les erreurs de requête. Le dépassement des limites applicables peut entraîner le rejet des requêtes ; les systèmes automatisés doivent donc être conçus pour respecter les limites indiquées dans la documentation officielle.

Avant d’utiliser l’API pour effectuer des transactions en direct, testez soigneusement la connexion, l’authentification, les autorisations et la logique des ordres. Pour consulter les dernières exigences de sécurité et limites de débit, référez-vous à la documentation actuelle de l’API WEEX.

Conclusion

Pour débuter avec l’API WEEX, choisissez la documentation officielle appropriée, créez une clé API, configurez ses autorisations, sécurisez les identifiants et connectez une application au point de terminaison API correspondant.

Les développeurs peuvent commencer par envoyer des requêtes à l’API publique avant de passer aux fonctions authentifiées de compte ou de trading. Pour connaître les points de terminaison, les exigences d’authentification, les autorisations et les limites de débit en vigueur, la dernière documentation de l’API WEEX doit rester la référence technique principale.

FAQ

1. Où trouver la documentation officielle de l’API WEEX ?
WEEX propose une documentation dédiée à ses produits API, ses points de terminaison, l’authentification, les connexions WebSocket, les paramètres et des exemples de réponses. Les développeurs doivent utiliser la version la plus récente, car les fonctionnalités de l’API peuvent évoluer au fil du temps.

2. Comment créer une clé API WEEX ?
Connectez-vous à la plateforme Web WEEX, puis ouvrez la gestion des API pour créer et configurer une clé API. Chaque compte peut actuellement créer jusqu’à 10 groupes de clés API.

3. Quelles informations dois-je enregistrer après avoir créé une clé API WEEX ?
Conservez en lieu sûr l’APIKey, la SecretKey et la Passphrase. Une Passphrase perdue ne peut pas être récupérée : si vous la perdez, vous devrez créer une nouvelle clé API.

4. Quelles autorisations une nouvelle clé API WEEX possède-t-elle ?
Par défaut, une nouvelle clé API Spot dispose d’un accès en lecture seule. Pour effectuer des opérations de trading au comptant, l’autorisation de trading Spot correspondante doit être activée.

5. Pourquoi ma requête API WEEX ne fonctionne-t-elle pas ?
Les causes courantes comprennent des identifiants incorrects, des autorisations insuffisantes, des erreurs de signature, des différences d’horodatage, des restrictions d’adresse IP ou des limites de débit. Selon l’erreur renvoyée par la requête, consultez la section correspondante de la documentation officielle de l’API WEEX.