Ukuqalisa

Ukuqinisekisa ubuwena

Isicelo ngasinye siphethe ukhiye wakho we-API. Ukhiye ukhomba umsebenzisi wakho futhi unquma lokho impendulo engakuletha.

1Ephanelini yokulawula, vula ithebhu ethi I-akhawunti Yami › API bese uchofoza inkinobho ethi Dala ukhiye. Mnike igama elizokukhumbuza ukuthi ukhiye uzosetshenziswa kuphi, njengokuthi “Ukuqapha”.
2Kopisha ukhiye ngokushesha: ngenxa yokuphepha, uboniswa kanye kuphela. Uma ungasenaye, mhoxise bese udala omusha.
3Thumela ukhiye ku-header ethi X-API-Key noma njenge-Authorization: Bearer.

Sebenzisa ukhiye kuseva kuphela. Ungalokothi umfake emakhasini ewebhu, kuma-app noma ezixhumanisini: i-API yenqaba okhiye abathunyelwe ku-URL. Umsebenzisi ngamunye angaba nokhiye abasebenzayo abafika ku-10 futhi angahoxisa noma yimuphi wabo kuthebhu efanayo yephaneli yokulawula.

Ifomethi yokhiye

Ukhiye uqala ngo-apk_, bese kulandela izinhlamvu ezingu-48. Ephanelini yokulawula, ukhiye ngamunye uboniswa ngokuqala kwakhe kuphela, okuyinani elifanayo nelenkambu ethi api_key.prefix ku-/me.

Ukuhoxisa nokushintsha okhiye

Ukuhoxisa ukhiye kuvimba ngokushesha izicelo ezenziwa ngaye. Ukuze ushintshe ukhiye ngaphandle kokumisa uhlelo lwakho, dala omusha, umfake kuseva yakho, bese kuthi ngemuva kwalokho uhoxise omdala.

Uma uhlelo lwakho ludinga ingxenye nje yedatha, dala ephanelini yokulawula umsebenzisi okhethekile walo, onezimvume ezidingekayo kuphela, bese udala ukhiye ku-akhawunti yalowo msebenzisi.

Lokho umsebenzisi ngamunye angakubona

IsicelocURLPHPJavaScript

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

Nge-header ethi Authorization

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

Akukho khiye noma ukhiye ohoxisiwe401

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