快速入门

身份验证

每个请求都需要携带您的 API 密钥。密钥用于识别您的用户，并决定响应中可以包含哪些内容。

1在控制面板中打开我的账户 › API，然后点击生成密钥。为密钥取一个能体现用途的名称，例如“监控”。
2请立即复制密钥：出于安全考虑，密钥只显示一次。如果丢失，请撤销该密钥并重新生成。
3通过 X-API-Key 请求头或 Authorization: Bearer 发送密钥。

密钥仅限在服务器端使用。 切勿将密钥放入网页、应用或链接中：API 会拒绝通过 URL 发送的密钥。每个用户最多可拥有 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."
  }
}