Aloitus

Todennus

Jokaisessa pyynnössä on mukana API-avaimesi. Se tunnistaa käyttäjäsi ja määrittää, mitä vastaus voi sisältää.

1Avaa ohjauspaneelissa Oma tili › API ja napsauta Luo avain. Anna avaimelle nimi, josta muistat, missä sitä käytetään, esimerkiksi ”Valvonta”.
2Kopioi avain heti: turvallisuussyistä se näytetään vain kerran. Jos kadotat sen, mitätöi se ja luo uusi.
3Lähetä avain otsakkeessa X-API-Key tai muodossa Authorization: Bearer.

Käytä avainta vain palvelimella. Älä koskaan lisää sitä verkkosivuille, sovelluksiin tai linkkeihin: API hylkää osoitteessa lähetetyt avaimet. Jokaisella käyttäjällä voi olla enintään 10 aktiivista avainta, ja hän voi mitätöidä minkä tahansa niistä samalla ohjauspaneelin välilehdellä.

Avaimen muoto

Avain alkaa merkkijonolla apk_, jota seuraa 48 merkkiä. Ohjauspaneelissa jokaisesta avaimesta näytetään vain alku, sama arvo kuin päätepisteen /me kentässä api_key.prefix.

Avainten mitätöinti ja vaihtaminen

Kun mitätöit avaimen, sillä tehdyt pyynnöt estetään heti. Jos haluat vaihtaa avaimen pysäyttämättä järjestelmääsi, luo uusi avain, vaihda se palvelimelle ja mitätöi vanha vasta sen jälkeen.

Jos järjestelmäsi tarvitsee vain osan tiedoista, luo sille ohjauspaneelissa oma käyttäjä, jolla on vain tarvittavat oikeudet, ja luo avain tämän käyttäjän tilillä.

Mitä kukin käyttäjä näkee

Pyyntö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-otsakkeella

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

Avain puuttuu tai se on mitätöity401

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