Antete obligatorii ale cererii
Fiecare cerere (cu excepția /v1/health) trebuie să transporte aceste patru antete. Dacă oricare lipsește sau este invalid, serverul respinge cu HTTP 401.
| Header | Format | Semnificație |
|---|---|---|
KH-Key | kh_live_[A-Z0-9]{32} | Identificatorul public al cheii. Nu este un secret, poate apărea în jurnale. |
KH-Timestamp | Secunde Unix (10 cifre) | Marcaj temporal curent. Fereastră de toleranță +-300s. |
KH-Nonce | 22-44 caractere base64url | Valoare de unică folosință per cerere. Memorată 600s, apoi poate fi reutilizată. |
KH-Signature | 64 hex | HMAC-SHA256(secret, signing_string), codificat hexazecimal. |
Construirea șirului de semnare
Șirul de semnat este compus din cinci componente, separate prin caracter de linie nouă (\n).
signing_string = METHOD + "\n"
+ PATH + "\n"
+ TIMESTAMP + "\n"
+ NONCE + "\n"
+ SHA256_HEX(BODY)
signature = HEX( HMAC_SHA256(secret, signing_string) )
PATH este calea începând cu /v1, de exemplu /v1/orders, nu /cp/kernelhost_api/v1/orders. Dacă cererea are un șir de interogare, acesta face parte din PATH (de exemplu /v1/services?limit=10&offset=0). BODY este corpul brut al cererii; pentru cererile fără corp, BODY este un șir vid, al cărui SHA256 este constanta binecunoscută e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.
Implementări de referință
PHP:
$method = 'POST';
$path = '/v1/orders';
$body = json_encode(['product_id' => 42, 'billing_cycle' => 'monthly', 'hostname' => 'web01.example.com']);
$idem = 'order-web01-' . date('Ymd');
$ts = (string) time();
$nonce = bin2hex(random_bytes(16));
$signing = "{$method}\n{$path}\n{$ts}\n{$nonce}\n" . hash('sha256', $body);
$sig = hash_hmac('sha256', $signing, getenv('KH_SECRET'));
$ch = curl_init('https://www.kernelhost.com/cp/kernelhost_api/v1/orders');
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_CUSTOMREQUEST => 'POST',
CURLOPT_POSTFIELDS => $body,
CURLOPT_HTTPHEADER => [
'Content-Type: application/json',
'KH-Key: ' . getenv('KH_KEY'),
"KH-Timestamp: {$ts}",
"KH-Nonce: {$nonce}",
"KH-Signature: {$sig}",
"Idempotency-Key: {$idem}",
],
]);
$res = curl_exec($ch);
Node.js:
import crypto from 'node:crypto';
const method = 'POST';
const path = '/v1/orders';
const body = JSON.stringify({ product_id: 42, billing_cycle: 'monthly', hostname: 'web01.example.com' });
const idem = 'order-web01-' + new Date().toISOString().slice(0, 10).replaceAll('-', '');
const ts = Math.floor(Date.now() / 1000).toString();
const nonce = crypto.randomBytes(16).toString('hex');
const bodyHash = crypto.createHash('sha256').update(body).digest('hex');
const signing = `${method}\n${path}\n${ts}\n${nonce}\n${bodyHash}`;
const sig = crypto.createHmac('sha256', process.env.KH_SECRET).update(signing).digest('hex');
const res = await fetch('https://www.kernelhost.com/cp/kernelhost_api/v1/orders', {
method: 'POST',
headers: {
'Content-Type': 'application/json',
'KH-Key': process.env.KH_KEY,
'KH-Timestamp': ts,
'KH-Nonce': nonce,
'KH-Signature': sig,
'Idempotency-Key': idem,
},
body,
});
Protecție împotriva atacurilor replay
O cerere semnată cu succes NU poate fi retrimisă. Serverul stochează fiecare nonce timp de 600s în baza de date; o a doua cerere cu același nonce este respinsă cu replay_detected. La fel, o cerere al cărei marcaj temporal diferă cu mai mult de 300s față de ora serverului este respinsă.
Modelul de permisiuni
Fiecare cheie are o listă explicită de permisiuni. Rutele verifică permisiunea necesară; dacă lipsește, se returnează HTTP 403 forbidden_scope. Permisiunile de scriere și cele sensibile trebuie activate explicit la crearea cheii.
read:products,read:orders,read:services,read:billing,read:webhooksread:credentials(Citirea credențialelor serviciilor (hostname, adrese IP, nume de utilizator, parolă). Generează la fiecare apel o intrare suplimentară de audit credentials.read.)write:orders(Plasarea și plata comenzilor.)write:services(Executarea acțiunilor asupra serviciilor (start, stop, reboot, rezilierea la sfârșitul perioadei de facturare și revocarea acesteia).)write:webhooks(Setarea adresei URL pentru webhook.)

