Začíname

Overovanie

Každá požiadavka obsahuje váš kľúč k API. Ten identifikuje vášho používateľa a určuje, čo môže odpoveď obsahovať.

1V ovládacom paneli otvorte Môj účet › API a kliknite na Vygenerovať kľúč. Pomenujte kľúč tak, aby ste vedeli, kde sa bude používať, napríklad „Monitorovanie“.
2Kľúč si hneď skopírujte: z bezpečnostných dôvodov sa zobrazí iba raz. Ak ho stratíte, odvolajte ho a vygenerujte nový.
3Posielajte kľúč v hlavičke X-API-Key alebo ako Authorization: Bearer.

Kľúč používajte iba na serveri. Nikdy ho nevkladajte do webových stránok, aplikácií ani odkazov: API odmieta kľúče poslané v adrese. Každý používateľ môže mať až 10 aktívnych kľúčov a ktorýkoľvek z nich môže odvolať na tej istej karte ovládacieho panela.

Formát kľúča

Kľúč sa začína reťazcom apk_, za ktorým nasleduje 48 znakov. V ovládacom paneli sa pri každom kľúči zobrazuje iba jeho začiatok, teda rovnaká hodnota ako v poli api_key.prefix endpointu /me.

Odvolanie a výmena kľúčov

Odvolaním kľúča sa okamžite zablokujú požiadavky, ktoré sa s ním odosielajú. Ak chcete kľúč vymeniť bez prerušenia prevádzky systému, vygenerujte nový, nahraďte ho na serveri a až potom odvolajte starý.

Ak váš systém potrebuje iba časť údajov, vytvorte preň v ovládacom paneli samostatného používateľa iba s potrebnými oprávneniami a kľúč vygenerujte v účte tohto používateľa.

Čo vidia jednotliví používatelia

PožiadavkacURLPHPJavaScript

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"

Chýbajúci alebo odvolaný kľúč401

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