Prvi koraci

Autentifikacija

Svaki zahtjev sadrži vaš API ključ. On identificira vašeg korisnika i određuje šta odgovor može sadržavati.

1Na kontrolnoj ploči otvorite Moj račun › API i kliknite na Kreiraj ključ. Dajte ključu naziv koji podsjeća na to gdje će se koristiti, na primjer „Monitoring“.
2Odmah kopirajte ključ: iz sigurnosnih razloga prikazuje se samo jednom. Ako ga izgubite, opozovite ga i kreirajte novi.
3Šaljite ključ u zaglavlju X-API-Key ili kao Authorization: Bearer.

Koristite ključ samo na serveru. Nikada ga ne stavljajte na web-stranice, u aplikacije ili linkove: API odbija ključeve poslane u adresi. Svaki korisnik može imati do 10 aktivnih ključeva i može opozvati bilo koji od njih na istoj kartici kontrolne ploče.

Format ključa

Ključ počinje s apk_, nakon čega slijedi 48 znakova. Na kontrolnoj ploči svaki ključ se prikazuje samo po početku, što je ista vrijednost kao u polju api_key.prefix iz /me.

Opozivanje i zamjena ključeva

Opozivanje ključa odmah blokira zahtjeve poslane s njim. Da zamijenite ključ bez prekida rada sistema, kreirajte novi, zamijenite ga na serveru i tek onda opozovite stari.

Ako vašem sistemu treba samo dio podataka, kreirajte na kontrolnoj ploči zasebnog korisnika za njega, samo s potrebnim dozvolama, a ključ kreirajte na računu tog korisnika.

Šta koji korisnik vidi

ZahtjevcURLPHPJavaScript

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

Sa zaglavljem Authorization

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

Bez ključa ili s opozvanim ključem401

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