API アクセス

#概要

Yeap Cloud コンソールは、HTTPS JSON API 群を使用して動作します。このページでは、API の接続先、認証の仕組み、およびプログラムからのアクセスに関する現在の制限について説明します。

#API エンドポイント

https://api.yeap.cloud

• 認証エンドポイントは /auth/... 配下にあります。例: /auth/login、/auth/refresh-token。
• ログインが必要なエンドポイントは /api/user/... 配下にあります。例: /api/user/profile。

リクエストとレスポンスは JSON 形式です。リクエストボディを送信する際は Content-Type: application/json を指定してください。

#認証

#アクセストークン

コンソールにログインすると、サーバーがアクセストークン（JWT）を発行します。/api/user/... 配下のエンドポイントを呼び出す際は、リクエストヘッダーで送信してください。

Authorization: Bearer <access-token>

• アクセストークンの有効期間は約 24 hours です。
• トークンが未指定、無効、または期限切れの場合、API は HTTP 401 を返します。

{"error": "Unauthorized", "code": 401}

• アカウントが無効化されると、発行済みのトークンも直ちに使用できなくなります。
• コンソールからログアウトすると、現在のアクセストークンが無効化され、そのアカウントのリフレッシュトークンも失効します。

#リフレッシュトークン

ログイン時に ログイン状態を保持 にチェックを入れると、サーバーは有効期間が 14 days のリフレッシュトークンも発行します。アクセストークンの期限が切れた場合は、再ログインする代わりに、リフレッシュトークンを使って新しいアクセストークンを取得できます。

curl -X POST https://api.yeap.cloud/auth/refresh-token \
  -H "Content-Type: application/json" \
  -d '{"refresh_token": "<refresh-token>"}'

成功時のレスポンスは次のようになります。

{"success": true, "token": "<new-access-token>", "user": { ... }}

リフレッシュトークンが無効または期限切れの場合、レスポンスは {"success": false, "error": "Invalid or expired refresh token"} となり、再ログインが必要です。コンソールでは、この更新処理が自動的に行われます。

#ログインには人間による操作の確認が必要です

/auth/login の呼び出しでは、毎回、人間による操作の確認（コンソールではポップアップで表示されます）を通過する必要があります。二要素認証を有効にしているアカウントでは、ワンタイムコードの入力も必要です。このため、現時点では、スクリプトによる無人ログインはできません。

#例: プロフィールの取得

curl https://api.yeap.cloud/api/user/profile \
  -H "Authorization: Bearer <access-token>"

成功時のレスポンスは次のようになります。

{"success": true, "data": {"id": 123, "username": "...", "email": "...", ...}}

ほとんどのユーザー向けエンドポイントは {"success": true, "data": ...} という形式で返します。エラー時は {"success": false, "error": "description"} を返します。

#設定の「API キー」

個人設定 → API キー タブでは、API キーの作成、一覧表示、削除ができます。

1. 説明を入力し、鍵を生成 をクリックします。
2. キーは 一度だけ表示されます。すぐにコピーして安全な場所に保管してください。
3. 既存の鍵 一覧には、各キーの ID、作成日時、最終使用日時が表示されます。不要になったキーは 削除 をクリックして削除します。

#CDN の「DNS API」ページで扱う認証情報について

/cdn/dns-api の CDN → DNS API では、サードパーティ DNS プロバイダー（現在は Cloudflare）の API 認証情報を保存します。Zone.Zone.Read と Zone.DNS.Edit の権限を持つ API Token の使用を推奨します。この認証情報は、DNS-01 検証を通じて CDN ドメインの SSL 証明書を自動取得するために使用されます。Yeap Cloud API へのアクセスとは関係ありません。CDN ドキュメントを参照してください。

#製品固有のキー

製品によっては、このページで説明するコンソールのトークンとは別に、独自のキーを使用します。例として LLM API → トークン管理 があります。各製品のドキュメントを参照してください。

#セキュリティ上の推奨事項

• アクセストークンとリフレッシュトークンがあれば、ログイン済みと同じ操作が可能です。他者と共有したり、ソース管理にコミットしたりしないでください。
• トークンが漏えいした可能性がある場合は、コンソールからログアウトしてパスワードを変更してください。
• アカウントの二要素認証を有効にしてください。