Unuaj paŝoj

Aŭtentigo

Ĉiu peto portas vian API-ŝlosilon. Ĝi identigas vian uzanton kaj difinas, kion la respondo povas enhavi.

1En la kontrolpanelo, malfermu Mia konto › API kaj alklaku Generi ŝlosilon. Donu al ĝi nomon, kiu memorigas, kie la ŝlosilo estos uzata, ekzemple „Monitorado“.
2Kopiu la ŝlosilon tuj: pro sekureco, ĝi aperas nur unufoje. Se vi perdos ĝin, revoku ĝin kaj generu alian.
3Sendu la ŝlosilon en la kaplinio X-API-Key aŭ kiel Authorization: Bearer.

Uzu la ŝlosilon nur en la servilo. Neniam metu ĝin en retpaĝojn, aplikaĵojn aŭ ligilojn: la API rifuzas ŝlosilojn senditajn en la adreso. Ĉiu uzanto povas havi ĝis 10 aktivajn ŝlosilojn kaj povas revoki iun ajn el ili en la sama langeto de la kontrolpanelo.

Formato de la ŝlosilo

La ŝlosilo konsistas el apk_ kaj 48 pliaj signoj. En la kontrolpanelo, ĉiu ŝlosilo aperas nur per sia komenco, la sama valoro kiel la kampo api_key.prefix de /me.

Revoki kaj anstataŭigi ŝlosilojn

Revoko de ŝlosilo tuj blokas la petojn faritajn per ĝi. Por anstataŭigi la ŝlosilon sen haltigi vian sistemon, generu la novan, ŝanĝu ĝin en la servilo kaj nur poste revoku la malnovan.

Se via sistemo bezonas nur parton de la datumoj, kreu en la kontrolpanelo uzanton nur por ĝi, kun nur la necesaj permesoj, kaj generu la ŝlosilon en la konto de tiu uzanto.

Kion ĉiu uzanto povas vidi

PetocURLPHPJavaScript

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

Per la kaplinio Authorization

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

Sen ŝlosilo aŭ kun revokita ŝlosilo401

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