Kuanza

Uthibitishaji

Kila ombi hubeba ufunguo wako wa API. Ufunguo huo humtambulisha mtumiaji wako na huamua jibu linaweza kuleta nini.

1Kwenye paneli ya udhibiti, fungua Akaunti Yangu › API na ubofye Unda ufunguo. Upe jina litakalokukumbusha mahali ufunguo utatumika, kama “Ufuatiliaji”.
2Nakili ufunguo mara moja: kwa sababu za usalama, unaonyeshwa mara moja tu. Ukiupoteza, ubatilishe na uunde mwingine.
3Tuma ufunguo kwenye kichwa X-API-Key au kama Authorization: Bearer.

Tumia ufunguo kwenye seva pekee. Usiuweke kamwe kwenye kurasa za wavuti, programu au viungo: API inakataa funguo zinazotumwa kwenye anwani. Kila mtumiaji anaweza kuwa na hadi funguo 10 hai na anaweza kubatilisha ufunguo wowote kwenye kichupo hicho hicho cha paneli ya udhibiti.

Muundo wa ufunguo

Ufunguo huanza na apk_, ukifuatiwa na herufi 48. Kwenye paneli ya udhibiti, kila ufunguo huonyeshwa kwa mwanzo wake tu, ambao ni thamani ile ile ya sehemu api_key.prefix ya /me.

Kubatilisha na kubadilisha funguo

Kubatilisha ufunguo huzuia papo hapo maombi yanayotumwa kwa ufunguo huo. Ili kubadilisha ufunguo bila kusimamisha mfumo wako, unda mpya, uweke kwenye seva yako, kisha ndipo ubatilishe ule wa zamani.

Ikiwa mfumo wako unahitaji sehemu tu ya data, unda kwenye paneli ya udhibiti mtumiaji maalum kwa ajili yake, mwenye ruhusa zinazohitajika pekee, na uunde ufunguo kwenye akaunti ya mtumiaji huyo.

Kila mtumiaji anaweza kuona nini

OmbicURLPHPJavaScript

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

Kwa kichwa Authorization

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

Bila ufunguo au kwa ufunguo uliobatilishwa401

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