AIアグエント用APIガイド

ベースURLおよびリクエストフォーマット

リクエストは https://seohabit.com/api/v1 を使用します。JSON 本文は Content-Type: application/json で送信してください。ウェブサイトのプロジェクトと自動送信の進捗には認証が必要です。リクエストの頻度には制限があります。

第三者の提出を追跡

有効なディレクトリ情報を持つプロジェクトを作成することで、対象のプロバイダーへの自動投稿を有効にできます。UTC1日あたり最大2回まで試行され、5つの承認されたディレクトリに達した時点で終了します。SEOHabitは背景で適格ディレクトリを選択します。ユーザーはディレクトリリストを確認または選択しません。適格なプロバイダーが存在しない場合は、プロジェクトは待機状態になります。承認は公開または検証されたバックリンクとはなりません。

ジョブの状態を確認

ステータスURLをポールして、ジョブがcompletedまたはfailedに達するまで待ちます。各ポールでは、ジョブのアクセストークンをヘッダーに認証してください。ジョブトークンはそのジョブの独自のアクセスにのみ使用されます。

curl 'https://seohabit.com/api/v1/jobs/job_example' \
  -H 'X-Access-Token: YOUR_JOB_ACCESS_TOKEN'

応答には queued, running, completed, failed のいずれかが含まれます。result はまだ利用可能ではありません。

アカウント、プロジェクトキー、および有料アクション

アカウント登録およびログインではHttpOnly sh_sessionクッキーが設定されます。ブラウザクッキーの書き込みはオリジンチェックされます。統合の際には、ログイン済みアカウントがプロジェクトスコープのAPIキーを作成し、明示的なスコープとともにAuthorization: Bearer shk_…として送信できます。キーは他のプロジェクトにアクセスできません。キーのスコープは利用可能な操作を制限します。セッションクッキーおよびAPIキーは秘密に保ってください。URLに含まれてはいけません。

キーワードタスクはdetails.keywordを受け取り、オプションでdetails.language（デフォルトはen）およびオプションで明示的なdetails.pageUrlを受け取ります。提案は一致するページの証拠を表示し、不明な言語または検索要望をマークします。

サイトの診断は、無料プロジェクトの無料制限内でキューできます。監視されるバックリンク、タスク作成、タスク実行は、確認済みのサイトおよび有効なサブスクリプションが必要です。有料アクションは、個人が所有権を確立し、アカウントの決済フローを通じて明示的にサブスクリプションを取得する必要があります。チェックアウト、サブスクリプション、またはサイトの変更を第三者の代わりに開始しないでください。タスク実行は変更が適用されたことを証明しません。準備されたタスクは、ユーザーの確認と承認が必要です。

プロジェクトキーはproject:read、project:write、checks:write、tasks:writeをサポートしています。キーは自身のプロジェクトにのみ適用されます。ルートとリクエストの形状についてはOpenAPIドキュメントをご確認ください。

エラーと安全な使用

エラーはerrorおよびmessageを使用したJSONで返されます。一般的な応答には、不正な入力または危険なURLに対して400、認証が不足している場合の401、許可されていないオリジンまたはスコープに対して403、リソースが利用できない場合の404、衝突がある場合の409、レート制限がある場合の429、有料アクションが有効なサブスクリプションが必要な場合の402が含まれます。

許可された範囲内の公開ページのみを確認してください。サービスはプライベートページおよびローカルネットワークの目的地をブロックし、ソースサイトが提供しているクローラーポリシーがある場合はそれに従います。リトライ可能なPOSTリクエストにはidempotencyキーを使用し、レート制限の応答にはバックオフ処理を適用してください。