Առաջին քայլեր

Նույնականացում

Յուրաքանչյուր հարցում պարունակում է ձեր API բանալին։ Այն նույնականացնում է ձեր օգտատիրոջը և որոշում, թե ինչ կարող է պարունակել պատասխանը։

1. 1Կառավարման վահանակում բացեք Իմ հաշիվը › API բաժինը և սեղմեք Ստեղծել բանալի։ Տվեք բանալուն անուն, որը կհիշեցնի, թե որտեղ է այն օգտագործվելու, օրինակ՝ «Մոնիթորինգ»։
2. 2Պատճենեք բանալին անմիջապես. անվտանգության նկատառումներով այն ցուցադրվում է միայն մեկ անգամ։ Եթե կորցնեք այն, հետ կանչեք և ստեղծեք նորը։
3. 3Ուղարկեք բանալին X-API-Key վերնագրով կամ որպես Authorization: Bearer։

Բանալու ձևաչափը

Բանալին սկսվում է apk_ նախածանցով, որին հաջորդում է 48 նիշ։ Կառավարման վահանակում յուրաքանչյուր բանալի ցուցադրվում է միայն իր սկզբնամասով, որը նույնն է, ինչ /me վերջնակետի api_key.prefix դաշտի արժեքը։

Բանալիների հետկանչ և փոխարինում

Բանալին հետ կանչելիս դրանով կատարվող հարցումներն անմիջապես արգելափակվում են։ Բանալին փոխարինելու համար՝ առանց ձեր համակարգը կանգնեցնելու, ստեղծեք նորը, տեղադրեք այն սերվերում և միայն դրանից հետո հետ կանչեք հինը։

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

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

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