Први кораци

Аутентификација

Сваки захтев садржи ваш API кључ. Он идентификује вашег корисника и одређује шта одговор може да садржи.

1На контролној табли отворите Мој налог › API и кликните на Направи кључ. Дајте кључу назив који подсећа на то где ће се користити, на пример „Мониторинг“.
2Одмах копирајте кључ: из безбедносних разлога приказује се само једном. Ако га изгубите, опозовите га и направите нови.
3Шаљите кључ у заглављу X-API-Key или као Authorization: Bearer.

Користите кључ само на серверу. Никада га не стављајте на веб-странице, у апликације или линкове: API одбија кључеве послате у адреси. Сваки корисник може имати до 10 активних кључева и може да опозове било који од њих на истој картици контролне табле.

Формат кључа

Кључ почиње са apk_, иза чега следи 48 знакова. На контролној табли сваки кључ се приказује само по почетку, што је иста вредност као у пољу api_key.prefix из /me.

Опозивање и замена кључева

Опозивање кључа одмах блокира захтеве послате са њим. Да бисте заменили кључ без прекида рада система, направите нови, замените га на серверу и тек онда опозовите стари.

Ако вашем систему треба само део података, направите на контролној табли засебног корисника за њега, само са потребним дозволама, а кључ направите на налогу тог корисника.

Шта који корисник види

ЗахтевcURLPHPJavaScript

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

Са заглављем Authorization

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

Без кључа или са опозваним кључем401

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