API-dokumentaatio
Pääse käsiksi salattuihin tietoihisi ohjelmallisesti käyttämällä turvallista REST-rajapintaamme token-pohjaisella todennuksella.
Luvut
Aloitus
Luo API-avain tilisi asetuksissa aloittaaksesi
Käyttääksesi Hexbon API:ta, sinun on luotava API-avain Tiliasetukset → API-asetukset -sivultasi. API käyttää kaksivaiheista todennusvirtaa parannetun turvallisuuden takaamiseksi.
Todennusvirta
Pyydä Token
Käytä API-avaintasi pyytääksesi väliaikaisen pääsytokenin POST /api/v1/auth kautta
Tokenin Voimassaolo
Token on voimassa 60 minuuttia. Vanhenemisen jälkeen pyydä uusi token.
Käytä Tokenia
Sisällytä token Authorization: Bearer <token> -otsikkoon datatoimintoja varten.
Nopeusrajoitus
API on rajoitettu 10 pyyntöön minuutissa käyttäjää kohden. Tämän rajan ylittäminen johtaa 429 Too Many Requests -vastaukseen.
Päätepisteet
Todennus
https://hexbon.com/api/v1/auth
Luo väliaikainen pääsytoken käyttämällä API-avaintasi.
Otsikot
| X-API-Key | API-avaimesi (pakollinen) |
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
}
Lue
https://hexbon.com/api/v1/data
Hae salatut tietosi. Palauttaa asiakkaan salaaman hyötykuorman (v1:...).
Otsikot
| Authorization | Bearer <token> (pakollinen) |
curl -X GET "https://hexbon.com/api/v1/data" \ -H "Authorization: Bearer your_token_here"
{
"success": true,
"data": "v1:encrypted_payload_here..."
}
Päivitä
https://hexbon.com/api/v1/data
Tallenna salatut tietosi. Hyväksyy asiakkaan salaaman hyötykuorman (v1:...) pyynnön rungossa.
Huomautus: Kirjoitusoikeuden on oltava käytössä API-asetukset -sivullasi. Oletuksena API-käyttö on vain luku -tilassa.
Otsikot
| Authorization | Bearer <token> (pakollinen) |
| Content-Type | application/json (pakollinen) |
Pyynnön Runko
| data | Asiakkaan salaama hyötykuorma, joka alkaa v1: (pakollinen) |
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."
}
Vastausmuoto
Kaikki API-vastaukset palautetaan JSON-muodossa, jossa on boolean-kenttä success, joka osoittaa toiminnon tuloksen.
{ "success": true, "data": "..." }
{ "success": false, "message": "Error description" }
Virhekoodit
| Koodi | Kuvaus |
|---|---|
| 401 | Virheellinen tai puuttuva API-avain / token vanhentunut |
| 403 | Kirjoitusoikeus poistettu käytöstä (POST /data varten) |
| 422 | Virheellinen hyötykuorman muoto tai tallennusraja ylitetty |
| 429 | Nopeusrajoitus ylitetty (10 pyyntöä/minuutti) |
| 500 | Sisäinen palvelinvirhe |
Valmis aloittamaan?
Luo API-avaimesi ja aloita integrointi Hexbonin kanssa tänään.
Siirry API-asetuksiin