Une clé API permet à une application d’accéder à certaines parties de votre compte BitcoinVN. Traitez chaque clé comme un mot de passe : toute personne qui l’obtient peut être en mesure de consulter des informations du compte ou d’effectuer les actions autorisées par ses permissions.
Créer et nommer une clé
Avant de créer une clé, vérifiez que le compte principal ou le sous-compte VIP prévu est actif.
Ensuite :
- Ouvrez Gérer les clés API.
- Sélectionnez Générer une nouvelle clé.
- Copiez la clé dans l’application qui l’utilisera.
- Sélectionnez Modifier.
- Ajoutez un libellé qui identifie l’application ou son usage.
- Choisissez ses permissions et les restrictions IP facultatives, puis enregistrez.
Utilisez une clé distincte pour chaque application afin de pouvoir restreindre ou révoquer une intégration sans affecter les autres. N’incluez aucun secret ni renseignement personnel dans le libellé.
Choisir les permissions minimales nécessaires
BitcoinVN propose deux niveaux de permission :
- Lecture seule : Peut consulter les données du compte, mais ne peut pas créer d’ordres.
- Lecture et écriture : Peut consulter les données du compte et créer des ordres.
Une clé en lecture et écriture peut utiliser le solde de votre compte pour créer des ordres et envoyer le produit vers une destination de règlement. Toute personne qui obtient cette clé peut être en mesure de retirer vos fonds.
Utilisez l’accès en lecture seule sauf si l’application doit réellement créer des ordres.
Restreindre l’accès par adresse IP
Vous pouvez limiter une clé à certaines adresses IP depuis sa page de modification :
- Saisissez une adresse IP par ligne.
- Ajoutez uniquement les adresses utilisées par l’application prévue.
- Ne laissez le champ vide que si l’application ne peut pas utiliser une adresse IP stable.
Les requêtes provenant d’autres adresses ne seront pas acceptées lorsqu’une restriction IP est configurée. Mettez la liste à jour si l’adresse de l’application change.
Utiliser la clé avec l’API
Envoyez la clé dans l’en-tête de requête X-API-KEY :
X-API-KEY: <your-api-key>Le texte ci-dessus est uniquement un exemple. Ne placez jamais une vraie clé dans du code public, des captures d’écran, des messages au support, des applications exécutées dans le navigateur, des URL ou des journaux.
La documentation interactive de l’API est disponible sur bitcoinvn.io/api/doc.
Comprendre le contexte des sous-comptes
Une clé API reste associée au compte qui était actif lors de sa création :
- Les clés créées dans le compte principal utilisent le compte principal.
- Les clés créées lorsqu’un sous-compte est actif utilisent ce sous-compte.
Changer de compte sur le site ne modifie pas une clé existante. Vérifiez le compte actif avant de la générer.
Révoquer ou remplacer une clé
Ouvrez Gérer les clés API et sélectionnez Révoquer à côté d’une clé devenue inutile. La révocation est irréversible.
Si une clé a pu être exposée :
- Révoquez-la.
- Générez une clé de remplacement.
- Appliquez les permissions et restrictions IP nécessaires.
- Mettez à jour l’application prévue.
N’envoyez jamais une clé API au support BitcoinVN ni à une personne prétendant représenter BitcoinVN.