Documentação da API
Acesse programaticamente seus dados criptografados usando nossa API REST segura com autenticação baseada em token.
Capítulos
Começando
Gere uma chave de API nas configurações da sua conta para começar
Para usar a API Hexbon, você precisa gerar uma chave de API na sua página de Configurações da Conta → Configurações da API. A API usa um fluxo de autenticação de duas etapas para maior segurança.
Fluxo de Autenticação
Solicitar um Token
Use sua chave de API para solicitar um token de acesso temporário via POST /api/v1/auth
Validade do Token
O token é válido por 60 minutos. Após expirar, solicite um novo token.
Usar o Token
Inclua o token no cabeçalho Authorization: Bearer <token> para operações de dados.
Limite de Taxa
A API é limitada a 10 solicitações por minuto por usuário. Exceder este limite resultará em uma resposta 429 Too Many Requests.
Endpoints
Autenticar
https://hexbon.com/api/v1/auth
Gere um token de acesso temporário usando sua chave de API.
Cabeçalhos
| X-API-Key | Sua chave de API (obrigatório) |
curl -X POST "https://hexbon.com/api/v1/auth" \ -H "X-API-Key: your_api_key_here"
{
"success": true,
"bearer_token": "abc123def456...",
"expires_at": "2025-11-27T15:30:00Z",
"expires_in": 3600
}
Ler
https://hexbon.com/api/v1/data
Recupere seus dados criptografados. Retorna a carga útil criptografada pelo cliente (v1:...).
Cabeçalhos
| Authorization | Bearer <token> (obrigatório) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Atualizar
https://hexbon.com/api/v1/data
Salve seus dados criptografados. Aceita uma carga útil criptografada pelo cliente (v1:...) no corpo da solicitação.
Nota: O acesso de gravação deve estar habilitado em suas Configurações da API. Por padrão, o acesso à API é somente leitura.
Cabeçalhos
| Authorization | Bearer <token> (obrigatório) |
| Content-Type | application/json (obrigatório) |
Corpo da Solicitação
| data | Carga útil criptografada pelo cliente começando com v1: (obrigatório) |
curl -X POST "https://hexbon.com/api/v1/data" \
-H "Authorization: Bearer your_token_here" \
-H "Content-Type: application/json" \
-d '{"data": "v2:your_encrypted_payload"}'
{
"success": true,
"message": "Encrypted data saved successfully."
}
Formato de Resposta
Todas as respostas da API são retornadas no formato JSON com um campo booleano success indicando o resultado da operação.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Códigos de Erro
| Código | Descrição |
|---|---|
| 401 | Chave de API inválida ou ausente / token expirado |
| 403 | Acesso de gravação desabilitado (para POST /data) |
| 422 | Formato de carga útil inválido ou limite de armazenamento excedido |
| 429 | Limite de taxa excedido (10 solicitações/minuto) |
| 500 | Erro interno do servidor |
Pronto para Começar?
Gere sua chave de API e comece a integrar com o Hexbon hoje.
Ir para Configurações da API