コンテンツにスキップ
AstroWay/api v2.325.2 · ja
すべてのシステムが正常です

WordPress サイトキー

Last updated Markdownとして開く エージェント設定

AstroWay WordPressプラグインは、登録なしで自動的にキーを取得します。サイトはRESTルートで証明を提示し、私たちはそれを検証して、そのサイトに紐付けられたキーを発行します。

  1. プラグインはproof_id (UUID v4) と proof (base64url形式の32バイトのランダムなデータ、43文字) を生成し、これらを10分間保持します。
  2. サイトは Content-Type: application/json ヘッダーと {"proof":"<proof>"} のボディで GET <home_url>/wp-json/astroway/v1/verify?nonce=<proof_id> を返します。
  3. プラグインは POST /v1/site-keys を送信します:
{ "site_url": "https://example.com", "proof_id": "3f1c2a9e-8b7d-4c1e-9f3a-2b6d5e4c1a07", "proof": "<43 characters>" }

site_url は home_url() と完全に一致し、? や # は含みません。シンプルなパーマリンクの場合、verify_url に ?rest_route=/astroway/v1/verify を含めて渡してください。これは同じサイトでのみ、かつこのルートとしてのみ受け入れられます。

  • サイトのサーバーの場合: ブラウザからのリクエスト(Origin ヘッダー付き)は403を受け取ります。各呼び出しでは X-AstroWay-Site-URL でサイトを指定する必要があります。紐付けはこのヘッダーに依存するため、キーは秘密として保管し、もし漏洩した場合は新しいキーを取得してください。以前のキーは取り消されます。
  • 無料の読み取りセット、サイトあたり1時間あたり300回の呼び出し(クレジットなし)。日付指定のホロスコープは、今日の日付の近くの日付のみ受け付けられます。
  • インストールごとに1つのキー(ホストとホームパス)。1つのホストにつき最大5つのインストールが可能で、時間あたりの制限は共有されます。

エラー: 400 INVALID_SITE_URL、details.reason を伴う 422 SITE_VERIFICATION_FAILED、retry_after を伴う 429 SITE_KEY_RATE_LIMIT。

サイトの所有者が自分のプランで作業したい場合、プラグインはワンクリックでサイトをアカウントキーに切り替えます。

  1. プラグインは管理者のブラウザで https://api.astroway.info/dashboard/connect?site=<home_url>&return=<admin_url>&state=<16-128 文字>&source=wp_plugin を開きます。return は site と同じホストで、かつHTTPSである必要があります。
  2. 管理者はログインまたは登録し、サイト用のキーを選択するか、新しいキーを作成します。すでに別のドメインに紐付けられているキーは、個別の確認後にのみ移行されます。
  3. ブラウザは code と同じ state を伴って return に戻ります。キャンセルされた場合は error=access_denied が返されます。
  4. サイトのサーバーは、X-Api-Key にサイトキーを送信してコードを交換します:
POST /v1/site-keys/connect/exchange
{ "code": "<43 characters>", "site_url": "https://example.com" }

応答: { "key": "aw_live_…", "plan": "free", "domain": "example.com", "account": "j***@example.com" }。コードは5分間有効です。同じサイトキーで同じコードを10分以内に再度交換した場合、同じ応答が返されます。サイトキーは交換後24時間で無効になります。

エラー: 400 INVALID_CODE、410 CODE_EXPIRED、403 SITE_MISMATCH。