Por que usar um SDK?
O SDK foi criado para tornar a integração mais rápida, organizada e segura. Ao utilizar o SDK, você reduz a complexidade da implementação porque:- não precisa montar requisições manualmente para cada endpoint;
- centraliza a autenticação com a sua
SECRET_KEY; - trabalha com métodos mais diretos e fáceis de manter;
- reduz a chance de erro na integração;
- acelera a implementação dos recursos mais comuns da API.
Quando faz sentido usar?
O SDK é indicado quando você possui uma aplicação backend e quer integrar a BeehiveHub no seu servidor, API própria, painel administrativo, backoffice ou backend de e-commerce. Exemplos de uso:- criação de transações Pix, boleto e cartão;
- consulta de transações e clientes;
- criação de recebedores e transferências;
- geração de links de pagamento;
- automações internas do seu sistema financeiro.
Recomendamos o uso dos SDKs para integrações server-side. Nunca utilize sua SECRET_KEY no front-end.
Escolha sua linguagem
Node.js
SDK oficial para aplicações Node.js e TypeScript.
PHP
SDK oficial para aplicações PHP.
Python
SDK oficial para aplicações Python.
Java
SDK oficial para aplicações Java.
Perguntas Frequentes
Como instalo o SDK da minha linguagem?
Como instalo o SDK da minha linguagem?
Cada SDK possui uma página dedicada com as instruções de instalação. De forma geral, utilize o gerenciador de pacotes da sua linguagem:
- Node.js:
npm install @paybeehive/beehivehub-nodejs-sdk - PHP:
composer require paybeehive/beehivehub-php-sdk - Python:
pip install beehivehub-python-sdk - Java: via Maven ou Gradle — veja a página do SDK Java
Os SDKs funcionam em sandbox e em produção?
Os SDKs funcionam em sandbox e em produção?
Sim. Todos os SDKs suportam os dois ambientes. Para usar o ambiente de testes, passe
environment: "sandbox" ao inicializar o cliente. Para produção, basta não informar o parâmetro ou usar a chave da conta de produção.Preciso usar um SDK ou posso chamar a API diretamente?
Preciso usar um SDK ou posso chamar a API diretamente?
O uso do SDK é recomendado, mas opcional. Você pode integrar diretamente pela API REST usando qualquer cliente HTTP. A vantagem do SDK é eliminar a configuração manual de autenticação, tratamento de erros e estrutura das requisições.
O que fazer se encontrar um bug em um SDK?
O que fazer se encontrar um bug em um SDK?
Abra uma issue no repositório GitHub do SDK correspondente. Nossa equipe acompanha os repositórios e trabalha para corrigir problemas e evoluir os SDKs continuamente.