IA y Postman
Dos atajos para integrar más rápido: una collection de Postman para probar todos los endpoints y la documentación completa en Markdown para agentes de IA y generadores de código.
Collection de Postman
Todos los endpoints de /v1, con cuerpos de ejemplo, respuestas de ejemplo y la autenticación ya configurada. Las solicitudes están en dos carpetas: Read, sin efectos secundarios, y Write, que crea payouts, payins y direcciones fijas o cambia la configuración.
En Postman, use Import y arrastre el archivo, o pegue la URL https://bifrostcrypto.com/postman-collection.json. Después abra la pestaña Variables de la collection y complete apiKey.
Variables de la collection
baseUrlURL de la API, sin /v1. Ya viene completada.
apiKeySu clave de API. Va en la cabecera X-Bifrost-Invoke en cada solicitud.
signingSecretSecreto de firma de la clave. Solo para claves creadas con firma de solicitudes; en las demás, déjelo vacío.
webhookUrlSu endpoint HTTPS de webhooks, usado por Create Payout y Create Payin. Empieza vacío.
payoutAddressWallet de destino de Create Payout. Empieza vacía, para que nada salga por error.
payoutReference · payinReferencereference_id del próximo payout o payin. Cámbielo en cada operación nueva.
payoutInternalReference · payinInternalReferenceSe completan solas con Create Payout y Create Payin. Las usan Check Specific Payout y Check Specific Payin.
No hay sandbox público: la collection habla con la cuenta real de la clave, y Create Payout envía fondos reales. payoutAddress y webhookUrl empiezan vacíos, así que un payout enviado por error se rechaza con invalid_parameters. El reference_id sale de payoutReference y payinReference: enviar la misma solicitud dos veces se rechaza como duplicada en lugar de pagar dos veces, por eso cambie la variable en cada operación nueva. Empiece con montos pequeños.
Si la clave exige firma de solicitudes, complete signingSecret: un script de la collection agrega X-Bifrost-Timestamp, X-Bifrost-Nonce y X-Bifrost-Signature a cada solicitud. Las claves sin firma la ignoran.
Documentación para IA
Los agentes de IA y los generadores de código leen mejor un archivo de texto que páginas HTML con navegación. Por eso la documentación completa también existe en Markdown, en un solo archivo: un resumen de las reglas en las que los agentes suelen equivocarse, autenticación y firma de solicitudes, guías, webhooks y verificación de firma, códigos de error, todos los endpoints con campos y ejemplos, el changelog y recetas de integración.
Archivos
/ai.mdLa documentación completa en inglés, con un resumen para agentes al principio y recetas de integración al final.
/ai/pt-BR.md · /ai/es.md · /ai/fr.mdEl mismo archivo con las guías y las explicaciones en cada idioma. La referencia de los endpoints sigue en inglés.
/ai/{locale}/{page}.mdUna sola página de esta documentación, por ejemplo /ai/es/create-payout-single.md.
/llms.txtÍndice breve en el formato llms.txt, que las herramientas de IA buscan en la raíz del sitio. Apunta a los archivos anteriores.
/postman-collection.jsonCollection de Postman v2.1.
/openapi.jsonEspecificación OpenAPI 3.1, generada de la misma fuente.
Uso con un asistente
Pase al asistente la URL del archivo Markdown y describa lo que quiere integrar. Algunos puntos de partida:
Recibir pagos
Lee la documentación de la API en https://bifrostcrypto.com/ai/es.md.
Implementa en mi backend:
1. la creación de un payin para un pedido, usando el id del pedido como reference_id y guardando el internal_reference;
2. un endpoint de webhook que verifique X-Bifrost-Signature sobre el cuerpo sin procesar, responda 2xx de inmediato y marque el pedido como pagado en payment_confirmed después de comparar received_amount con crypto_amount.
Lee la clave de la API de la variable de entorno BIFROST_API_KEY y la clave de webhook de BIFROST_WEBHOOK_KEY.Enviar payouts
Lee la documentación de la API en https://bifrostcrypto.com/ai/es.md.
Implementa una rutina de payout que envíe hasta 50 payouts por solicitud a POST /v1/payout, con un reference_id estable por payout y un Idempotency-Key por solicitud. Lee results[] por index, guarda el internal_reference de los ítems creados y reenvía solo los rechazados, decidiendo por error.code.
Lee la clave de la API de la variable de entorno BIFROST_API_KEY.Dirección fija por cliente
Lee la documentación de la API en https://bifrostcrypto.com/ai/es.md.
Implementa una dirección fija de depósito por cliente con POST /v1/fixed-wallets, usando nuestro id de cliente como customer_info, y un handler de webhook que acredite al cliente en payment_confirmed en los depósitos con is_wallet_fixed true.
Lee la clave de la API de la variable de entorno BIFROST_API_KEY y la clave de webhook de BIFROST_WEBHOOK_KEY.Nunca pegue la clave de la API, el secreto de firma ni la clave de webhook en el chat de un asistente. Pídale que los lea de variables de entorno.