API BitcoinVN - Guia de integração e casos de uso

    BitcoinVN oferece uma API REST que permite que desenvolvedores integrem troca instantânea de criptomoedas em suas próprias aplicações. A documentação interativa completa está disponível em bitcoinvn.io/api/doc.

    Primeiros passos

    1. Prepare o acesso à API: Leia Como gerenciar chaves de API com segurança e gere uma chave na página de chaves de API se sua integração usar endpoints privados.
    2. Explore os endpoints: Navegue pela interface Swagger interativa em bitcoinvn.io/api/doc ou baixe a especificação OpenAPI em bitcoinvn.io/api/doc.json
    3. Ir ao vivo: Crie cotações, envie pedidos e receba notificações webhook

    Autenticação

    Endpoints públicos não exigem uma chave de API. Para endpoints privados, envie sua chave no cabeçalho de solicitação X-API-KEY. Consulte Como gerenciar chaves de API com segurança para obter instruções sobre criação, restrição, uso e revogação de chaves.

    Fluxo de trabalho principal

    1. GET /api/info - Descobrir ativos suportados e métodos de transferência
    2. POST /api/quotes - Bloquear uma taxa de câmbio por 15 minutos
    3. POST /api/orders - Criar um pedido usando o ID da cotação e detalhes de liquidação
    4. Cliente envia depósito para o endereço fornecido na resposta do pedido
    5. GET /api/orders/{shortId} - Acompanhar status do pedido ou ouvir callbacks webhook

    Casos de uso

    • Agregadores de swaps: Liste BitcoinVN como provedor de troca em 100+ ativos
    • Pagamentos de comerciantes: Aceite pagamentos em criptomoedas de clientes em todo o mundo
    • Carteiras e apps: Incorpore funcionalidade de troca diretamente na sua carteira ou app
    • Trading automatizado: Construa bots que monitoram taxas e executam swaps programaticamente
    • Contabilidade e relatórios: Use endpoints de saldo e razão para histórico de transações
    • Dashboards de staking: Consulte ofertas de staking atuais e gerencie preferências de auto-stake

    Recursos principais

    • 100+ ativos suportados em múltiplas redes
    • Cotações vinculantes com preços garantidos por 15 minutos
    • Notificações webhook para atualizações de status de pedido em tempo real
    • Nenhum dado pessoal necessário para trocas simples de cripto para cripto
    • Especificação OpenAPI 3.0 para geração fácil de código de cliente

    Suporte ao desenvolvedor

    Para dúvidas de integração, junte-se ao nosso chat Telegram para desenvolvedores ou contate-nos em [email protected].

    Publicado: