Алғашқы қадамдар

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

Әр сұраныс API кілтіңізбен жіберіледі. Кілт пайдаланушыңызды анықтайды және жауапта не болуы мүмкін екенін белгілейді.

1Басқару панелінде Менің аккаунтым › API бөлімін ашып, Кілт жасау түймесін басыңыз. Кілтке қай жерде қолданылатынын еске салатын атау беріңіз, мысалы: «Мониторинг».
2Кілтті бірден көшіріп алыңыз: қауіпсіздік үшін ол тек бір рет көрсетіледі. Егер жоғалтсаңыз, оның күшін жойып, жаңасын жасаңыз.
3Кілтті X-API-Key тақырыбында немесе Authorization: Bearer ретінде жіберіңіз.

Кілтті тек серверде қолданыңыз. Оны ешқашан веб-беттерге, қолданбаларға немесе сілтемелерге қоспаңыз: API URL мекенжайында жіберілген кілттерді қабылдамайды. Әр пайдаланушыда ең көбі 10 белсенді кілт болуы мүмкін және ол кез келгенінің күшін басқару панелінің сол қойындысында жоя алады.

Кілт форматы

Кілт apk_ таңбаларымен басталады, одан кейін 48 таңба келеді. Басқару панелінде әр кілттің тек басы көрсетіледі, бұл /me жауабындағы api_key.prefix өрісінің мәнімен бірдей.

Кілттердің күшін жою және ауыстыру

Кілттің күшін жойғанда, сол кілтпен жасалған сұраныстар бірден бұғатталады. Жүйеңізді тоқтатпай кілтті ауыстыру үшін жаңасын жасаңыз, оны серверде ауыстырыңыз, содан кейін ғана ескісінің күшін жойыңыз.

Егер жүйеңізге деректердің бір бөлігі ғана қажет болса, басқару панелінде тек сол жүйеге арналған, қажетті рұқсаттары ғана бар пайдаланушы жасап, кілтті сол пайдаланушының аккаунтында жасаңыз.

Әр пайдаланушы нені көре алады

Сұраныс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."
  }
}