Autenticação

Cabeçalhos obrigatórios da requisição

Toda requisição (exceto /v1/health) deve enviar estes quatro cabeçalhos. Se algum estiver ausente ou inválido, o servidor rejeita com HTTP 401.

Header	Format	Significado
KH-Key	kh_live_[A-Z0-9]{32}	Identificador da chave pública. Não é um segredo, pode aparecer em logs.
KH-Timestamp	Segundos Unix (10 dígitos)	Timestamp atual. Janela de tolerância +-300s.
KH-Nonce	22-44 caracteres base64url	Valor de uso único por requisição. Mantido em cache por 600s e depois reutilizável.
KH-Signature	64 hex	HMAC-SHA256(secret, signing_string), codificado em hexadecimal.

Construindo a string de assinatura

A string a ser assinada é composta por cinco componentes unidos por nova linha (\n).

signing_string = METHOD + "\n"
               + PATH    + "\n"
               + TIMESTAMP + "\n"
               + NONCE   + "\n"
               + SHA256_HEX(BODY)

signature = HEX( HMAC_SHA256(secret, signing_string) )

PATH é o caminho a partir de /v1, por exemplo /v1/orders, e não /cp/kernelhost_api/v1/orders. Se o pedido tiver uma query string, esta faz parte de PATH (por exemplo /v1/services?limit=10&offset=0). BODY é o corpo bruto do pedido; em pedidos sem corpo, BODY é uma string vazia, cujo SHA256 é a constante bem conhecida e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855.

Implementações de referência

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,
});

Proteção contra replay

Uma requisição assinada com sucesso NÃO pode ser repetida. O servidor armazena cada nonce por 600s no banco de dados; uma segunda requisição com o mesmo nonce é rejeitada com replay_detected. Da mesma forma, uma requisição cujo timestamp se desvie mais de 300s do horário do servidor é rejeitada.

Modelo de escopos

Cada chave API tem uma lista explícita de escopos. As rotas verificam o escopo exigido; se faltar, retorna HTTP 403 forbidden_scope. Escopos de escrita e sensíveis precisam ser ativados explicitamente na criação da chave.

• read:products, read:orders, read:services, read:billing, read:webhooks
• read:credentials (Ler credenciais de serviço (hostname, endereços IP, nome de utilizador, palavra-passe). Cada chamada gera uma entrada de auditoria adicional credentials.read.)
• write:orders (Realizar e pagar pedidos.)
• write:services (Executar ações de serviço (start, stop, reboot, cancelamento no fim do período de faturação e respetiva revogação).)
• write:webhooks (Definir URL de webhook.)