İlk addımlar

Autentifikasiya

Hər sorğu API açarınızla göndərilir. Açar istifadəçinizi müəyyən edir və cavabda nələrin ola biləcəyini təyin edir.

1İdarəetmə panelində Hesabım › API bölməsini açın və Açar yarat düyməsinə klikləyin. Açara harada istifadə olunacağını xatırladan ad verin, məsələn, «Monitorinq».
2Açarı dərhal kopyalayın: təhlükəsizlik baxımından o, yalnız bir dəfə göstərilir. İtirsəniz, onu etibarsız edin və yenisini yaradın.
3Açarı X-API-Key başlığında və ya Authorization: Bearer kimi göndərin.

Açardan yalnız serverdə istifadə edin. Onu heç vaxt veb səhifələrə, tətbiqlərə və ya keçidlərə əlavə etməyin: API URL-də göndərilən açarları qəbul etmir. Hər istifadəçinin ən çoxu 10 aktiv açarı ola bilər və o, istənilən açarı idarəetmə panelinin həmin bölməsində etibarsız edə bilər.

Açarın formatı

Açar apk_ ilə başlayır, ardınca 48 simvol gəlir. İdarəetmə panelində hər açarın yalnız başlanğıcı göstərilir; bu, /me cavabındakı api_key.prefix sahəsinin dəyəri ilə eynidir.

Açarların etibarsız edilməsi və dəyişdirilməsi

Açarı etibarsız etdikdə onunla göndərilən sorğular dərhal bloklanır. Sisteminizi dayandırmadan açarı dəyişmək üçün yeni açar yaradın, onu serverdə dəyişdirin və yalnız bundan sonra köhnə açarı etibarsız edin.

Sisteminizə məlumatların yalnız bir hissəsi lazımdırsa, idarəetmə panelində yalnız onun üçün, yalnız lazımi icazələri olan bir istifadəçi yaradın və açarı həmin istifadəçinin hesabında yaradın.

Hər istifadəçi nəyi görə bilər

SorğucURLPHPJavaScript

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 başlığı ilə

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

Açar yoxdur və ya etibarsız edilib401

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