الخطوات الأولى

المصادقة

يحمل كل طلب مفتاح 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."
  }
}