Prvi koraki

Preverjanje pristnosti

Vsaka zahteva vsebuje vaš ključ API. Ta identificira vašega uporabnika in določa, kaj lahko vsebuje odgovor.

1Na nadzorni plošči odprite Moj račun › API in kliknite Ustvari ključ. Ključu dajte ime, iz katerega bo razvidno, kje se bo uporabljal, na primer »Nadzor«.
2Ključ takoj kopirajte: zaradi varnosti je prikazan samo enkrat. Če ga izgubite, ga razveljavite in ustvarite novega.
3Ključ pošljite v glavi X-API-Key ali kot Authorization: Bearer.

Ključ uporabljajte samo na strežniku. Nikoli ga ne vstavljajte v spletne strani, aplikacije ali povezave: API zavrne ključe, poslane v naslovu. Vsak uporabnik ima lahko največ 10 aktivnih ključev in lahko katerega koli od njih razveljavi na istem zavihku nadzorne plošče.

Oblika ključa

Ključ se začne z apk_, ki mu sledi 48 znakov. Na nadzorni plošči je vsak ključ prikazan samo z začetkom, ki je enak vrednosti polja api_key.prefix v /me.

Razveljavitev in zamenjava ključev

Razveljavitev ključa takoj blokira zahteve, poslane z njim. Če želite ključ zamenjati brez prekinitve delovanja sistema, ustvarite novega, ga zamenjajte na strežniku in šele nato razveljavite starega.

Če vaš sistem potrebuje samo del podatkov, na nadzorni plošči ustvarite zanj ločenega uporabnika samo s potrebnimi dovoljenji in ključ ustvarite v računu tega uporabnika.

Kaj vidi posamezni uporabnik

ZahtevacURLPHPJavaScript

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();

Z glavo Authorization

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

Manjkajoč ali razveljavljen ključ401

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