Premye pa

Otantifikasyon

Chak demann pote kle API ou. Kle a idantifye itilizatè ou epi li defini sa repons lan ka genyen.

1Nan panèl la, louvri Kont mwen › API epi klike sou Jenere kle. Ba li yon non ki fè w sonje kote w ap itilize kle a, tankou “Siveyans”.
2Kopye kle a touswit: pou sekirite, li parèt yon sèl fwa. Si w pèdi l, revoke l epi jenere yon lòt.
3Voye kle a nan antèt X-API-Key la oswa kòm Authorization: Bearer.

Itilize kle a sèlman sou sèvè a. Pa janm mete l nan paj wèb, aplikasyon oswa lyen: API a refize kle yo voye nan adrès la. Chak itilizatè ka gen jiska 10 kle aktif epi li ka revoke nenpòt nan yo nan menm onglè panèl la.

Fòma kle a

Kle a kòmanse ak apk_, epi apre sa li gen 48 karaktè. Nan panèl la, chak kle parèt sèlman ak kòmansman li, ki se menm valè ak chan api_key.prefix nan /me.

Revoke epi ranplase kle

Lè ou revoke yon kle, demann yo fè avè l bloke touswit. Pou ranplase kle a san w pa kanpe sistèm ou, jenere nouvo a, mete l sou sèvè a, epi se apre sa sèlman pou w revoke ansyen an.

Si sistèm ou bezwen sèlman yon pati nan done yo, kreye nan panèl la yon itilizatè espesyalman pou li, ak sèlman pèmisyon ki nesesè yo, epi jenere kle a nan kont itilizatè sa a.

Sa chak itilizatè ka wè

DemanncURLPHPJavaScript

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

Avèk antèt Authorization la

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

San kle oswa ak yon kle ki revoke401

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