Documentación de API
Acceda programáticamente a sus datos cifrados utilizando nuestra API REST segura con autenticación basada en tokens.
Capítulos
Comenzando
Genere una clave API en la configuración de su cuenta para comenzar
Para usar la API de Hexbon, necesita generar una clave API desde su página de Configuración de Cuenta → Configuración de API. La API utiliza un flujo de autenticación de dos pasos para mayor seguridad.
Flujo de Autenticación
Solicitar un Token
Use su clave API para solicitar un token de acceso temporal a través de POST /api/v1/auth
Validez del Token
El token es válido por 60 minutos. Después de expirar, solicite un nuevo token.
Usar el Token
Incluya el token en el encabezado Authorization: Bearer <token> para operaciones de datos.
Límite de Velocidad
La API está limitada a 10 solicitudes por minuto por usuario. Exceder este límite resultará en una respuesta 429 Too Many Requests.
Puntos Finales
Autenticar
https://hexbon.com/api/v1/auth
Genere un token de acceso temporal usando su clave API.
Encabezados
| X-API-Key | Su clave API (requerido) |
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
}
Leer
https://hexbon.com/api/v1/data
Recupere sus datos cifrados. Devuelve la carga útil cifrada por el cliente (v1:...).
Encabezados
| Authorization | Bearer <token> (requerido) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Actualizar
https://hexbon.com/api/v1/data
Guarde sus datos cifrados. Acepta una carga útil cifrada por el cliente (v1:...) en el cuerpo de la solicitud.
Nota: El acceso de escritura debe estar habilitado en su Configuración de API. Por defecto, el acceso a la API es de solo lectura.
Encabezados
| Authorization | Bearer <token> (requerido) |
| Content-Type | application/json (requerido) |
Cuerpo de la Solicitud
| data | Carga útil cifrada por el cliente comenzando con v1: (requerido) |
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 Respuesta
Todas las respuestas de la API se devuelven en formato JSON con un campo booleano success que indica el resultado de la operación.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Códigos de Error
| Código | Descripción |
|---|---|
| 401 | Clave API inválida o faltante / token expirado |
| 403 | Acceso de escritura deshabilitado (para POST /data) |
| 422 | Formato de carga útil inválido o límite de almacenamiento excedido |
| 429 | Límite de velocidad excedido (10 solicitudes/minuto) |
| 500 | Error interno del servidor |
¿Listo para Comenzar?
Genere su clave API y comience a integrar con Hexbon hoy.
Ir a Configuración de API