Pradžia

Autentifikavimas

Kiekvienoje užklausoje turi būti jūsų API raktas. Jis identifikuoja jūsų naudotoją ir nustato, ką gali pateikti atsakymas.

1Valdymo skydelyje atidarykite skiltį Mano paskyra › API ir spustelėkite Sukurti raktą. Suteikite raktui pavadinimą, primenantį, kur jis bus naudojamas, pavyzdžiui, „Stebėsena“.
2Nukopijuokite raktą iš karto: saugumo sumetimais jis rodomas tik vieną kartą. Jei jį pamesite, panaikinkite jį ir sukurkite naują.
3Siųskite raktą antraštėje X-API-Key arba kaip Authorization: Bearer.

Raktą naudokite tik serveryje. Niekada nedėkite jo į tinklalapius, programėles ar nuorodas: API atmeta raktus, siunčiamus URL adrese. Kiekvienas naudotojas gali turėti iki 10 aktyvių raktų ir bet kurį iš jų panaikinti tame pačiame valdymo skydelio skirtuke.

Rakto formatas

Raktas prasideda priešdėliu apk_, po kurio eina 48 simboliai. Valdymo skydelyje kiekvienas raktas rodomas tik pagal pradžią – tai ta pati reikšmė kaip /me lauko api_key.prefix.

Raktų panaikinimas ir keitimas

Panaikinus raktą, juo atliekamos užklausos iš karto blokuojamos. Norėdami pakeisti raktą nesustabdydami sistemos, sukurkite naują raktą, pakeiskite jį serveryje ir tik tada panaikinkite senąjį.

Jei jūsų sistemai reikia tik dalies duomenų, valdymo skydelyje sukurkite jai atskirą naudotoją tik su būtinomis teisėmis ir sukurkite raktą šio naudotojo paskyroje.

Ką gali matyti kiekvienas naudotojas

UžklausacURLPHPJavaScript

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

Su antrašte Authorization

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

Nėra rakto arba jis panaikintas401

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