צעדים ראשונים

אימות

כל בקשה כוללת את מפתח ה-API שלך. הוא מזהה את המשתמש שלך וקובע מה התגובה יכולה לכלול.

1. 1בלוח הבקרה, יש לפתוח את החשבון שלי › API וללחוץ על יצירת מפתח. כדאי לתת למפתח שם שמזכיר היכן הוא ישמש, למשל "ניטור".
2. 2יש להעתיק את המפתח מיד: מטעמי אבטחה, הוא מוצג פעם אחת בלבד. אם הוא אבד, יש לבטל את תוקפו וליצור מפתח חדש.
3. 3יש לשלוח את המפתח בכותרת X-API-Key או כ-Authorization: Bearer.

פורמט המפתח

המפתח מתחיל ב-apk_ ואחריו 48 תווים. בלוח הבקרה כל מפתח מוצג רק לפי ההתחלה שלו, שהיא אותו ערך כמו בשדה api_key.prefix של /me.

ביטול תוקף והחלפת מפתחות

ביטול התוקף של מפתח חוסם מיד את הבקשות שנשלחות איתו. כדי להחליף מפתח בלי לעצור את המערכת שלך, יש ליצור את המפתח החדש, להחליף אותו בשרת ורק אז לבטל את התוקף של הישן.

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

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

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