入門指南

身份驗證

每個請求都須附上你的 API 金鑰。金鑰用於識別你的用戶，並決定回應可包含哪些內容。

1在控制台開啟我的帳戶 › API，然後按產生金鑰。為金鑰取一個能提示用途的名稱，例如「監控」。
2請立即複製金鑰：基於安全理由，金鑰只會顯示一次。如遺失金鑰，請將其撤銷並重新產生。
3透過 X-API-Key 標頭，或以 Authorization: Bearer 方式傳送金鑰。

金鑰只應在伺服器上使用。 切勿將金鑰放入網頁、應用程式或連結中：API 會拒絕經網址傳送的金鑰。每位用戶最多可擁有 10 個有效金鑰，並可在控制台的同一分頁隨時撤銷任何一個。

金鑰格式

金鑰以 apk_ 開頭，後接 48 個字元。在控制台中，每個金鑰只會顯示開頭部分，即 /me 中 api_key.prefix 欄位的值。

撤銷及更換金鑰

撤銷金鑰後，使用該金鑰的請求會即時被封鎖。如要在不中斷系統的情況下更換金鑰，請先產生新金鑰，在伺服器上替換，然後才撤銷舊金鑰。

如你的系統只需要部分資料，請在控制台為它另外建立一個用戶，只授予所需權限，並在該用戶的帳戶產生金鑰。

各用戶可查看的內容

請求cURLPHPJavaScript

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

使用 Authorization 標頭

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

沒有金鑰或金鑰已撤銷401

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