当社独自のアクセス統計は常に有効です。Google Analyticsは、公開ページ(ログイン後のワークスペースは対象外)の利用状況を把握するためのもので、許可をいただいた場合のみ有効になります。詳しくは プライバシーポリシーをご覧ください。

POST

APIの稼働状況

24時間の稼働状況
正常
24時間の平均応答時間
—
  • 良好/正常
  • 利用可能
  • 制限あり
  • ほぼ停止
正常

EverySolveのCastle APIは、チャレンジ処理に使用するトークンのセットを返します。typeをcastleに設定し、以下の入力項目を指定してPOST /api/v1/captchaに送信してください。Castleはリスク判定とデバイスインテリジェンスのフローで、目に見える画像パズルではなく、対象側が構造化されたメタデータを提供します。 トークンセットを返します。このセットを1つのトークンにまとめたり、製品名から視覚的なCAPTCHAだと推測したりしないでください。

1,000トークンあたり$0.97(1トークンあたり$0.000972)。各呼び出しはトークン単位で課金され、金額は単価×countです。返されたトークン分のみ課金され、解決に失敗した場合は課金されません。

AIプロンプト

EveryInfraの「Castle」APIを呼び出すスクリプトの作成を手伝ってください。

APIの仕様:
- リクエスト:POST https://api.everyinfra.com/api/v1/captcha、ヘッダーはAuthorization: Bearer <API Key>。キーは環境変数EVERYINFRA_API_KEYから読み込み、コードには直接書かないでください。
- リクエストボディでは、typeをcastleに設定し、パラメータを同じ階層に並べてください。
- 必須パラメータ:
  - website_url: このチャレンジが表示されるページを正確に指定します。サイトのトップページだけでなく、該当するパスも含めてください。
  - website_key: 対象の実装からそのままコピーした公開サイトキーまたはウィジェットキーです。シークレットキーではありません。
  - metadata: 対象のCastleフローで必須となる、構造化された公開クライアントメタデータです。
- 任意パラメータ:
  - count: このタスクで要求する結果の数です。カタログに記載された制限の範囲内で指定します。
  - user_agent: このチャレンジセッションで使用するブラウザのユーザーエージェントです。返された結果がそのセッションに紐づく場合は、同じ値を使い続けてください。
  - proxy: 解決セッションで使用するプロキシです。結果がネットワークに紐づく場合は、その後の対象へのリクエストでも同じ出口を使用してください。
- リクエストボディの例:
{
  "type": "castle",
  "website_url": "<website_url>",
  "website_key": "<website_key>",
  "metadata": "<metadata>"
}
- 課金:1,000トークンあたり$0.97(1トークンあたり$0.000972)。各呼び出しはトークン単位で課金され、金額は単価×countです。返されたトークン分のみ課金され、解決に失敗した場合は課金されません。
- 422の場合は、エラーに含まれる提案と指定可能な値をもとにパラメータを修正してください。429または503の場合は、Retry-Afterで指定された時間だけ待ってから再試行してください。

コードを書く前に、処理する件数と結果の保存形式を私に確認し、そのうえで、計画と概算費用について私の了承を得てください。

リクエストパラメータ

名前場所型必須デフォルト説明
Authorizationheaderstringはい-Bearerの後にAPIキーを続けます。APIキーはコンソールで作成してください。URLやコードリポジトリには絶対に含めないでください。
typebodystringはいcastleCAPTCHAの種類です(固定値)。
website_urlbodystringはい-このチャレンジが表示されるページを正確に指定します。サイトのトップページだけでなく、該当するパスも含めてください。
website_keybodystringはい-対象の実装からそのままコピーした公開サイトキーまたはウィジェットキーです。シークレットキーではありません。
metadatabodyobjectはい-対象のCastleフローで必須となる、構造化された公開クライアントメタデータです。
countbodynumberいいえ-このタスクで要求する結果の数です。カタログに記載された制限の範囲内で指定します。
user_agentbodystringいいえ-このチャレンジセッションで使用するブラウザのユーザーエージェントです。返された結果がそのセッションに紐づく場合は、同じ値を使い続けてください。
proxybodystringいいえ-解決セッションで使用するプロキシです。結果がネットワークに紐づく場合は、その後の対象へのリクエストでも同じ出口を使用してください。

コードサンプル

bash
curl -X POST 'https://api.everyinfra.com/api/v1/captcha' \
  -H "Authorization: Bearer $EVERYINFRA_API_KEY" \
  -H 'Content-Type: application/json' \
  --data-raw '{
  "type": "castle",
  "website_url": "<website_url>",
  "website_key": "<website_key>",
  "metadata": "<metadata>"
}'

OpenAPI定義(JSON)サンプルは環境変数EVERYINFRA_API_KEYからAPIキーを読み込みます。コピーしたコードにAPIキーが含まれることはありません。

レスポンス例

フィールドプレビュー

このパラメータのサンプルレスポンスはまだありません。このプレビューはAPI定義に基づくレスポンスの構造とフィールドを示したもので、値は…で表しています。実際の呼び出し結果ではありません。

json
{
  "id": "req_…",
  "type": "castle",
  "solution": {
    "tokens": "…"
  },
  "billing": {
    "charged": …,
    "charged_usd": …,
    "balance_after_usd": …,
    …
  },
  "quota": { … }
}

Castleのパラメータの取得元

website_keyとmetadataは、対象サイトの同じ実装から取得する必要があります。count、user_agent、proxyは、リクエストコンテキストとして任意で指定できます。

ページ上でこれらの値を見つけるコード

castle-1.js
[...document.scripts].map(s=>s.src).filter(s=>/castle\.io/.test(s))

Castleの見分け方

Castleはリスク判定とデバイスインテリジェンスのフローで、目に見える画像パズルではなく、対象側が構造化されたメタデータを提供します。

Castleの特徴

トークンセットを返します。このセットを1つのトークンにまとめたり、製品名から視覚的なCAPTCHAだと推測したりしないでください。

Castle APIの使い方

Castle APIはtokensでトークンのセットを返します。ソリューションの形式はtokensです。 返されたトークンは、対象サイトのリクエストが想定する形式でまとめて送信します。

  1. 01GET /api/v1/captcha/typesを取得し、castleのエントリを選択します。
  2. 02type: "castle"と必須パラメータをPOST /api/v1/captchaに送信します。
  3. 03tokensからトークンのセットを読み取ります。
  4. 04返されたトークンは、対象サイトのリクエストが想定する形式でまとめて送信します。

課金と提供状況 このタイプはトークン単位の料金です。1回の呼び出しの料金は表示価格 × countで、返されたトークン分のみお支払いいただきます。EverySolveはソリューションを正常に返した場合のみ課金します。失敗した試行では最終的な課金は発生せず、仮押さえされた金額は自動的に戻ります。availableと価格フィールドはページ上の固定情報とみなさず、リクエスト時にGET /api/v1/captcha/typesから取得してください。

Castleの連携に関するよくある質問

タイプを選ぶ前に、Castleかどうかを見分けるにはどうすればよいですか?

Castleはリスク判定とデバイスインテリジェンスのフローで、目に見える画像パズルではなく、対象側が構造化されたメタデータを提供します。 castleは、これらのシグナルが対象のチャレンジと一致することを確認してから使用してください。

Castleリクエストには、対象ページのどの値を含めればよいですか?

website_keyとmetadataは、対象サイトの同じ実装から取得する必要があります。count、user_agent、proxyは、リクエストコンテキストとして任意で指定できます。 website_url、website_key、metadataを指定してください。 任意パラメータはcount、user_agent、proxyです。

Castleは何を返しますか?また、混同してはいけないものは何ですか?

Castle APIはtokensでトークンのセットを返します。ソリューションの形式はtokensです。 トークンセットを返します。このセットを1つのトークンにまとめたり、製品名から視覚的なCAPTCHAだと推測したりしないでください。

Castleの連携について説明している外部資料はどれですか?

Castleの公式サイトでは、リスク判定とデバイスインテリジェンス製品の概要が説明されています。[Castleのリファレンスを開く](https://castle.io/)。EverySolve固有のフィールドとリアルタイムの提供状況は、引き続きタイプカタログで確認してください。

Castleのリファレンス

すべてのCAPTCHAタイプ

エラーと課金

401
キーが未指定か無効です。
402
残高が不足しています。先にチャージしてください。
422
パラメータ名または値が無効です。エラーに含まれる候補を参考に修正してください。課金はされません。
429
1分あたりのリクエスト上限に達しました。Retry-Afterの指定に従って待ってから再試行してください。
503
処理を完了できませんでした。保留中の請求額は残高に戻されます。結果が不明な場合は、再試行する前に確認してください。
200(空)
データがありません。課金はされません。

エラー