Pagsisimula

Pag-authenticate

Bawat request ay may kasamang API key mo. Kinikilala nito ang iyong user at tinutukoy kung ano ang puwedeng isama sa response.

1Sa control panel, buksan ang Aking Account › API at i-click ang Gumawa ng key. Bigyan ito ng pangalang magpapaalala kung saan gagamitin ang key, gaya ng “Pagsubaybay”.
2Kopyahin agad ang key: para sa seguridad, isang beses lang ito ipapakita. Kung mawala mo ito, bawiin ito at gumawa ng bago.
3Ipadala ang key sa header na X-API-Key o bilang Authorization: Bearer.

Gamitin lang ang key sa server. Huwag na huwag itong ilagay sa mga web page, app o link: tinatanggihan ng API ang mga key na ipinadala sa URL. Bawat user ay puwedeng magkaroon ng hanggang 10 na aktibong key at puwedeng bawiin ang alinman sa mga ito sa parehong tab ng control panel.

Format ng key

Nagsisimula ang key sa apk_, na sinusundan ng 48 character. Sa control panel, ang simula lang ng bawat key ang ipinapakita, ang parehong value ng field na api_key.prefix ng /me.

Pagbawi at pagpapalit ng mga key

Kapag binawi ang isang key, agad na naba-block ang mga request na gumagamit nito. Para palitan ang key nang hindi pinapahinto ang iyong system, gumawa ng bago, palitan ito sa server at saka pa lang bawiin ang luma.

Kung bahagi lang ng data ang kailangan ng iyong system, gumawa sa control panel ng user na para lang dito, na may mga kinakailangang pahintulot lang, at gawin ang key sa account ng user na iyon.

Ano ang nakikita ng bawat user

RequestcURLPHPJavaScript

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

Gamit ang header na Authorization

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

Walang key o binawing key401

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