開発者のために
あなたのコードから、
新しいワークフローへ。
連携案を確認し、API に向けてアプリケーションを準備。
API 仕様案です。実際の利用前に、エンドポイント、パラメーター、レスポンスを API チームと確認してください。
はじめに
連携は 3 段階です。アプリケーションを識別し、タスクを作成して、結果を確認します。デモダッシュボードで体験できます。
1実際のサービスで認証情報を取得
2種類とパラメーターを指定してタスクを作成
3識別子で結果を取得
認証
仕様案では、認証情報 clientKey をサーバーからの呼び出しに使用します。キーは環境変数に保存し、公開コードやブラウザに含めないでください。デモのキーにはサービスへのアクセス権がありません。
タスクを作成
POST /createTask選択した種類に必要な認証情報とパラメーターを送信します。
// Contrato proposto — configure a URL da API real no servidor
const response = await fetch(API_BASE_URL + "/createTask", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
clientKey: process.env.SOLUCAPTCHA_API_KEY,
task: {
type: "RecaptchaV2Task",
websiteURL: "https://sua-aplicacao.com",
websiteKey: "SUA_SITE_KEY"
}
})
});
if (!response.ok) throw new Error("Falha ao criar tarefa");
const task = await response.json();想定レスポンス
{
"errorId": 0,
"taskId": "example-task-id"
}結果を取得
POST /getTaskResult次の識別子を使用します： taskId で状態を確認します。処理中の場合は、API が定める間隔と制限に従ってから再確認してください。
{
"clientKey": "SUA_CHAVE_NO_SERVIDOR",
"taskId": "example-task-id"
}状態とエラー
ready
タスクの結果を取得できます。
processing
タスクは処理中です。
error
返されたエラーコードと説明を確認してください。
無効な認証情報、残高不足、予期しないレスポンス、タイムアウトに対応してください。正式なエラー名は API 側で定義します。