スタートガイド

認証

すべてのリクエストにはAPIキーが必要です。キーによってユーザーが識別され、レスポンスに含められる内容が決まります。

1. 1コントロールパネルでマイアカウント › APIを開き、キーを生成をクリックします。「モニタリング」のように、キーの用途がわかる名前を付けてください。
2. 2キーはすぐにコピーしてください。セキュリティ上の理由から、キーは一度しか表示されません。紛失した場合は、そのキーを無効化して新しいキーを生成してください。
3. 3キーはX-API-Keyヘッダー、またはAuthorization: Bearerで送信します。

キーの形式

キーはapk_で始まり、その後に48文字が続きます。コントロールパネルでは各キーの先頭部分のみが表示され、これは/meのapi_key.prefixフィールドの値と同じです。

キーの無効化と切り替え

キーを無効化すると、そのキーを使ったリクエストは直ちに拒否されます。システムを止めずにキーを切り替えるには、新しいキーを生成してサーバー側で差し替えてから、古いキーを無効化してください。

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."
  }
}