API-dokumentasjon
Få tilgang til dine krypterte data programmatisk ved hjelp av vårt sikre REST API med token-basert autentisering.
Kapitler
Kom i gang
Generer en API-nøkkel i kontoinnstillingene dine for å starte
For å bruke Hexbon API, må du generere en API-nøkkel fra din Kontoinnstillinger → API-innstillinger side. API-et bruker en to-trinns autentiseringsflyt for økt sikkerhet.
Autentiseringsflyt
Be om Token
Bruk din API-nøkkel for å be om et midlertidig tilgangstoken via POST /api/v1/auth
Token Gyldighet
Tokenet er gyldig i 60 minutter. Etter utløp, be om et nytt token.
Bruk Token
Inkluder tokenet i Authorization: Bearer <token> overskriften for dataoperasjoner.
Hastighetsbegrensning
API-et er begrenset til 10 forespørsler per minutt per bruker. Overskridelse av denne grensen vil resultere i et 429 Too Many Requests svar.
Endepunkter
Autentiser
https://hexbon.com/api/v1/auth
Generer et midlertidig tilgangstoken ved hjelp av din API-nøkkel.
Overskrifter
| X-API-Key | Din API-nøkkel (påkrevd) |
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
}
Les
https://hexbon.com/api/v1/data
Hent dine krypterte data. Returnerer klient-kryptert nyttelast (v1:...).
Overskrifter
| Authorization | Bearer <token> (påkrevd) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Oppdater
https://hexbon.com/api/v1/data
Lagre dine krypterte data. Godtar klient-kryptert nyttelast (v1:...) i forespørselskroppen.
Merk: Skrivetilgang må være aktivert i dine API-innstillinger. Som standard er API-tilgang skrivebeskyttet.
Overskrifter
| Authorization | Bearer <token> (påkrevd) |
| Content-Type | application/json (påkrevd) |
Forespørselskropp
| data | Klient-kryptert nyttelast som starter med v1: (påkrevd) |
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."
}
Svarformat
Alle API-svar returneres i JSON-format med et boolsk felt success som indikerer resultatet av operasjonen.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Feilkoder
| Kode | Beskrivelse |
|---|---|
| 401 | Ugyldig eller manglende API-nøkkel / token utløpt |
| 403 | Skrivetilgang deaktivert (for POST /data) |
| 422 | Ugyldig nyttelastformat eller lagringsgrense overskredet |
| 429 | Hastighetsbegrensning overskredet (10 forespørsler/minutt) |
| 500 | Intern serverfeil |
Klar til å starte?
Generer din API-nøkkel og start integrasjonen med Hexbon i dag.
Gå til API-innstillinger