시작하기

인증

모든 요청에는 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."
  }
}