Začínáme

Ověřování

Každý požadavek obsahuje váš klíč k API. Ten identifikuje vašeho uživatele a určuje, co může odpověď obsahovat.

1V ovládacím panelu otevřete Můj účet › API a klikněte na Vygenerovat klíč. Pojmenujte klíč tak, abyste poznali, kde se bude používat, například „Monitoring“.
2Klíč si hned zkopírujte: z bezpečnostních důvodů se zobrazí jen jednou. Pokud ho ztratíte, odvolejte ho a vygenerujte nový.
3Posílejte klíč v hlavičce X-API-Key nebo jako Authorization: Bearer.

Klíč používejte jen na serveru. Nikdy ho nevkládejte do webových stránek, aplikací ani odkazů: API odmítá klíče poslané v adrese. Každý uživatel může mít až 10 aktivních klíčů a kterýkoli z nich může odvolat na stejné kartě ovládacího panelu.

Formát klíče

Klíč začíná na apk_, za nímž následuje 48 znaků. V ovládacím panelu se u každého klíče zobrazuje jen jeho začátek, tedy stejná hodnota jako v poli api_key.prefix endpointu /me.

Odvolání a výměna klíčů

Odvoláním klíče se okamžitě zablokují požadavky, které jsou s ním odesílány. Chcete-li klíč vyměnit bez přerušení provozu systému, vygenerujte nový, nahraďte ho na serveru a teprve potom odvolejte starý.

Pokud váš systém potřebuje jen část dat, vytvořte pro něj v ovládacím panelu samostatného uživatele jen s potřebnými oprávněními a klíč vygenerujte v účtu tohoto uživatele.

Co který uživatel vidí

PožadavekcURLPHPJavaScript

curl "https://api.on-cloud.live/v1/me" \
  -H "X-API-Key: $API_KEY"

<?php
$ch = curl_init('https://api.on-cloud.live/v1/me');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => ['X-API-Key: ' . getenv('API_KEY')],
]);
$response = json_decode(curl_exec($ch), true);

const res = await fetch('https://api.on-cloud.live/v1/me', {
  headers: { 'X-API-Key': process.env.API_KEY }
});
const { data } = await res.json();

S hlavičkou Authorization

curl "https://api.on-cloud.live/v1/me" \
  -H "Authorization: Bearer $API_KEY"

Chybějící nebo odvolaný klíč401

{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is invalid or has been revoked."
  }
}