Developer documentation

Authentication

API keys, workspaces, and scopes

REST requests use a workspace API key in the Bearer header. The full key is shown only once when created; store it in a secret manager.

Authentication headers

curl -H 'Authorization: Bearer <API_KEY>' \
  -H 'X-Workspace-Id: <WORKSPACE_ID>' \
  'https://<service-domain>/api/v1/platforms'

Workspace and scopes

Use X-Workspace-Id if the key belongs to more than one workspace. Every operation checks a scope such as accounts:read or posts:write. See the operation list.

For 401, check the key and login. For 403, check verification and scopes. Record X-Request-Id to investigate an error.

Error response without credentials

{
  "error": {
    "code": "unauthenticated",
    "message": "로그인 또는 인증 정보가 없습니다. 로그인하거나 유효한 키를 넣어 주세요."
  }
}

The REST response currently has a Korean message. Use the stable code and the English error guide.