Bem-vindo à API Belasis! A API foi desenvolvida para permitir a integração com diferentes serviços externos, facilitando o compartilhamento de dados e a automação de processos.
Guia de Integração
O objetivo deste guia é tornar o processo de integração com a API mais simples, rápido e eficiente.
1. Requisitos e Preparação
É fundamental que você e sua equipe técnica avaliem a documentação e esclareçam todas as dúvidas antes de começar a integração.
Para acessar a API, você precisa:
- Ter o recurso de API ativado em sua conta Belasis
- Gerar uma chave de API no painel de controle
- Utilizar a chave de autenticação em todas as requisições
2. Geração da API Key
Para gerar sua chave de API:
- Acesse seu painel Belasis
- Vá para Configurações → API
- Clique em Gerar token
- Copie e armazene em local seguro
A chave de API é pessoal e intransferível. Se necessário, você pode revogar a chave atual e gerar uma nova a qualquer momento.
3. Integração e Desenvolvimento
Consulte a documentação interativa para acessar:
- Lista completa de endpoints disponíveis
- Parâmetros esperados para cada requisição
- Exemplos de respostas de sucesso e erro
- Console interativo para testar os endpoints
Segurança
Boas práticas ao usar a API:
✅ Sempre use HTTPS
✅ Guarde sua chave em local seguro
✅ Use variáveis de ambiente para armazenar a chave
❌ Nunca compartilhe a chave em código público
❌ Não envie a chave em URLs
❌ Não coloque a chave em arquivos de configuração sem proteção
Suporte
Se tiver dúvidas ou encontrar problemas:
- Consulte a documentação interativa
- Verifique as mensagens de erro retornadas pela API
- Entre em contato com o suporte Belasis através do sistema