เริ่มต้นใช้งาน

การยืนยันตัวตน

ทุกคำขอต้องแนบคีย์ 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."
  }
}