IA et Postman

Deux raccourcis pour intégrer plus vite : une collection Postman pour essayer chaque endpoint, et toute la documentation en Markdown pour les agents d'IA et les générateurs de code.

Collection Postman

Tous les endpoints de /v1, avec des corps d'exemple, des réponses d'exemple et l'authentification déjà configurée. Les requêtes sont réparties en deux dossiers : Read, sans effet de bord, et Write, qui crée des payouts, des payins et des adresses fixes ou modifie la configuration.

Télécharger la collection Voir le JSON

Dans Postman, utilisez Import et déposez le fichier, ou collez l'URL https://bifrostcrypto.com/postman-collection.json. Ouvrez ensuite l'onglet Variables de la collection et renseignez apiKey.

Variables de la collection

baseUrl

string · facultatif

URL de l'API, sans /v1. Déjà renseignée.

apiKey

string · obligatoire

Votre clé d'API. Envoyée dans l'en-tête X-Bifrost-Invoke à chaque requête.

signingSecret

string · facultatif

Secret de signature de la clé. Uniquement pour les clés créées avec la signature des requêtes ; laissez vide sinon.

webhookUrl

string · facultatif

Votre endpoint HTTPS de webhooks, utilisé par Create Payout et Create Payin. Vide au départ.

payoutAddress

string · facultatif

Wallet de destination de Create Payout. Vide au départ, pour que rien ne parte par erreur.

payoutReference · payinReference

string · facultatif

reference_id du prochain payout ou payin. Changez-la à chaque nouvelle opération.

payoutInternalReference · payinInternalReference

string · facultatif

Renseignées automatiquement par Create Payout et Create Payin. Utilisées par Check Specific Payout et Check Specific Payin.

Il n'y a pas de sandbox public : la collection agit sur le compte réel de la clé, et Create Payout envoie de vrais fonds. payoutAddress et webhookUrl sont vides au départ, donc un payout envoyé par erreur est refusé avec invalid_parameters. Le reference_id vient de payoutReference et payinReference : envoyer deux fois la même requête est refusé comme doublon au lieu de payer deux fois, changez donc la variable à chaque nouvelle opération. Commencez avec de petits montants.

Si la clé exige la signature des requêtes, renseignez signingSecret : un script de la collection ajoute X-Bifrost-Timestamp, X-Bifrost-Nonce et X-Bifrost-Signature à chaque requête. Les clés sans signature l'ignorent.

Documentation pour l'IA

Les agents d'IA et les générateurs de code lisent mieux un fichier texte que des pages HTML avec navigation. C'est pourquoi toute la documentation existe aussi en Markdown, dans un seul fichier : un résumé des règles sur lesquelles les agents se trompent souvent, l'authentification et la signature des requêtes, les guides, les webhooks et la vérification de signature, les codes d'erreur, chaque endpoint avec ses champs et exemples, le changelog et des recettes d'intégration.

Ouvrir ai.md Ouvrir llms.txt

Fichiers

/ai.md

text/markdown

Toute la documentation en anglais, avec un résumé pour les agents au début et des recettes d'intégration à la fin.

/ai/pt-BR.md · /ai/es.md · /ai/fr.md

text/markdown

Le même fichier avec les guides et les explications dans chaque langue. La référence des endpoints reste en anglais.

/ai/{locale}/{page}.md

text/markdown

Une seule page de cette documentation, par exemple /ai/fr/create-payout-single.md.

/llms.txt

text/plain

Index court au format llms.txt, que les outils d'IA cherchent à la racine du site. Il renvoie aux fichiers ci-dessus.

/postman-collection.json

application/json

Collection Postman v2.1.

/openapi.json

application/json

Spécification OpenAPI 3.1, générée à partir de la même source.

Avec un assistant

Donnez à l'assistant l'URL du fichier Markdown et décrivez ce que vous voulez intégrer. Quelques points de départ :

Recevoir des paiements

prompt

Lis la documentation de l'API sur https://bifrostcrypto.com/ai/fr.md.
Implémente dans mon backend :
1. la création d'un payin pour une commande, avec l'id de la commande comme reference_id, en conservant l'internal_reference ;
2. un endpoint de webhook qui vérifie X-Bifrost-Signature sur le corps brut, répond 2xx tout de suite et marque la commande comme payée sur payment_confirmed après avoir comparé received_amount à crypto_amount.
Lis la clé d'API dans la variable d'environnement BIFROST_API_KEY et la clé de webhook dans BIFROST_WEBHOOK_KEY.

Envoyer des payouts

prompt

Lis la documentation de l'API sur https://bifrostcrypto.com/ai/fr.md.
Implémente une tâche de payout qui envoie jusqu'à 50 payouts par requête à POST /v1/payout, avec un reference_id stable par payout et un Idempotency-Key par requête. Lis results[] par index, conserve l'internal_reference des éléments créés et ne renvoie que ceux refusés, en décidant selon error.code.
Lis la clé d'API dans la variable d'environnement BIFROST_API_KEY.

Adresse fixe par client

prompt

Lis la documentation de l'API sur https://bifrostcrypto.com/ai/fr.md.
Implémente une adresse de dépôt fixe par client avec POST /v1/fixed-wallets, en utilisant notre id client comme customer_info, et un handler de webhook qui crédite le client sur payment_confirmed pour les dépôts avec is_wallet_fixed true.
Lis la clé d'API dans la variable d'environnement BIFROST_API_KEY et la clé de webhook dans BIFROST_WEBHOOK_KEY.

Ne collez jamais la clé d'API, le secret de signature ni la clé de webhook dans le chat d'un assistant. Demandez-lui de les lire dans des variables d'environnement.