API-Dokumentation
Greifen Sie programmgesteuert auf Ihre verschlüsselten Daten zu, indem Sie unsere sichere REST-API mit Token-basierter Authentifizierung verwenden.
Kapitel
Erste Schritte
Generieren Sie einen API-Schlüssel in Ihren Kontoeinstellungen, um zu beginnen
Um die Hexbon-API zu verwenden, müssen Sie einen API-Schlüssel auf Ihrer Kontoeinstellungen → API-Einstellungen-Seite generieren. Die API verwendet einen zweistufigen Authentifizierungsablauf für erhöhte Sicherheit.
Authentifizierungsablauf
Token anfordern
Verwenden Sie Ihren API-Schlüssel, um ein temporäres Zugriffstoken über POST /api/v1/auth anzufordern
Token-Gültigkeit
Das Token ist 60 Minuten lang gültig. Fordern Sie nach Ablauf ein neues Token an.
Token verwenden
Fügen Sie das Token in den Authorization: Bearer <token>-Header für Datenoperationen ein.
Ratenbegrenzung
Die API ist auf 10 Anfragen pro Minute pro Benutzer begrenzt. Das Überschreiten dieses Limits führt zu einer 429 Too Many Requests-Antwort.
Endpunkte
Authentifizieren
https://hexbon.com/api/v1/auth
Generieren Sie ein temporäres Zugriffstoken mit Ihrem API-Schlüssel.
Header
| X-API-Key | Ihr API-Schlüssel (erforderlich) |
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
}
Lesen
https://hexbon.com/api/v1/data
Rufen Sie Ihre verschlüsselten Daten ab. Gibt die clientseitig verschlüsselte Nutzlast zurück (v1:...).
Header
| Authorization | Bearer <token> (erforderlich) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Aktualisieren
https://hexbon.com/api/v1/data
Speichern Sie Ihre verschlüsselten Daten. Akzeptiert eine clientseitig verschlüsselte Nutzlast (v1:...) im Anfragetext.
Hinweis: Der Schreibzugriff muss in Ihren API-Einstellungen aktiviert sein. Standardmäßig ist der API-Zugriff schreibgeschützt.
Header
| Authorization | Bearer <token> (erforderlich) |
| Content-Type | application/json (erforderlich) |
Anfragetext
| data | Clientseitig verschlüsselte Nutzlast beginnend mit v1: (erforderlich) |
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."
}
Antwortformat
Alle API-Antworten werden im JSON-Format mit einem booleschen Feld success zurückgegeben, das das Operationsergebnis angibt.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Fehlercodes
| Code | Beschreibung |
|---|---|
| 401 | Ungültiger oder fehlender API-Schlüssel / abgelaufenes Token |
| 403 | Schreibzugriff deaktiviert (für POST /data) |
| 422 | Ungültiges Nutzlastformat oder Speicherlimit überschritten |
| 429 | Ratenlimit überschritten (10 Anfragen/Minute) |
| 500 | Interner Serverfehler |
Bereit loszulegen?
Generieren Sie Ihren API-Schlüssel und beginnen Sie noch heute mit der Integration von Hexbon.
Zu den API-Einstellungen