APIリファレンス

URLインデックスAPIドキュメント

IndexBoltのURLインデックスAPIを使えば、URLをGoogleにインデックス送信し、送信進捗を追跡し、クレジットをプログラムから管理できます。一括URLインデックスをSEOワークフロー、WordPressプラグイン、独自ツールに組み込みましょう。

ベースURL: https://indexbolt.com/api/v1JSONリクエスト&レスポンスBearerトークン認証

認証#

すべてのAPIリクエストには、AuthorizationヘッダーにBearerトークンが必要です。APIキーはダッシュボード設定から生成できます。

リクエストヘッダーの例
Authorization: Bearer ib_your_api_key_here
重要: APIキーはib_プレフィックスで始まります。キーは秘密にしてください。クライアントサイドのコードに露出させないでください。1アカウントにつき最大5つのAPIキーを作成できます。

レート制限#

レート制限は、スライディングウィンドウ方式でAPIキーごとに適用されます。レート制限がかかった場合は、429ステータスコードを受け取ります。

エンドポイント制限期間
POST /submit10リクエスト60秒
GET /balance30リクエスト60秒
GET /submissions, /submissions/:id60リクエスト60秒

レスポンスヘッダーX-RateLimit-RemainingX-RateLimit-Resetで現在の使用状況を確認できます。

エラー処理#

すべてのエラーは一貫したJSON構造で返されます。

{
  "success": false,
  "error": {
    "code": "ERROR_CODE",
    "message": "Human-readable description"
  }
}
HTTPステータスコード説明
400INVALID_INPUTリクエストボディまたはパラメータが不正です
401UNAUTHORIZEDAPIキーがないか無効です
402INSUFFICIENT_CREDITS操作に必要なクレジットが不足しています
403FORBIDDENメールが認証されていません
404NOT_FOUNDリソースが見つかりません
429RATE_LIMITEDリクエストが多すぎます
500INTERNAL_ERROR予期しないサーバーエラー

クレジットと料金#

通常インデックス

1 クレジット / URL

標準処理。URLをGoogleにインデックス送信します。

インスタントインデックス

10 クレジット / URL

インデックスを高速化する優先処理。

クレジットに有効期限はありません。1回の送信には1〜1,000件のURLを含められます。無効なURLは除外され、クレジットは消費されません。

URLを送信#

POST/api/v1/submit10リクエスト / 60秒

URLのバッチをGoogleにインデックス送信します。

リクエストボディ

パラメータタイプ必須説明
urlsstring[]必須インデックスするURLの配列(1〜1,000件)
indexingTypestring必須「normal」または「instant」
projectIdstring任意プロジェクトに紐付け
submissionNamestring任意送信のカスタム名

リクエスト例

cURL
curl -X POST https://indexbolt.com/api/v1/submit \
  -H "Authorization: Bearer ib_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "urls": [
      "https://example.com/page-1",
      "https://example.com/page-2"
    ],
    "indexingType": "normal"
  }'

レスポンス — 201 Created

{
  "success": true,
  "data": {
    "submissionId": "sub_abc123",
    "totalUrls": 2,
    "creditsUsed": 2,
    "balanceAfter": 98,
    "invalidUrls": []
  }
}
URL検証: URLはHTTP/HTTPSを使い、2,048文字未満で、公開アドレスを指している必要があります。プライベート/内部IP(localhost、10.x.x.x、192.168.x.xなど)は拒否されます。重複URLは自動的に削除されます。

送信一覧#

GET/api/v1/submissions60リクエスト / 60秒

送信のページネーション付きリストを取得します。

クエリパラメータ

パラメータタイプ必須説明
pageinteger任意ページ番号(デフォルト:1)
pageSizeinteger任意1ページあたりの結果数、最大100(デフォルト:20)
statusstring任意「queued」、「processing」、「completed」、「partial_failure」、「failed」

リクエスト例

cURL
curl https://indexbolt.com/api/v1/submissions?page=1&pageSize=10 \
  -H "Authorization: Bearer ib_your_api_key"

レスポンス — 200 OK

{
  "success": true,
  "data": {
    "submissions": [
      {
        "id": "sub_abc123",
        "name": "Submission #1",
        "status": "completed",
        "indexingType": "normal",
        "totalUrls": 5,
        "creditsUsed": 5,
        "createdAt": "2025-01-15T10:30:00Z",
        "completedAt": "2025-01-15T11:45:00Z"
      }
    ],
    "pagination": {
      "page": 1,
      "pageSize": 10,
      "total": 45,
      "totalPages": 5
    }
  }
}

送信を取得#

GET/api/v1/submissions/:id60リクエスト / 60秒

URLごとのステータスを含む、送信の詳細を取得します。

パスパラメータ

パラメータタイプ必須説明
idstring必須送信ID

リクエスト例

cURL
curl https://indexbolt.com/api/v1/submissions/sub_abc123 \
  -H "Authorization: Bearer ib_your_api_key"

レスポンス — 200 OK

{
  "success": true,
  "data": {
    "id": "sub_abc123",
    "name": "Submission #1",
    "status": "completed",
    "indexingType": "normal",
    "totalUrls": 5,
    "creditsUsed": 5,
    "createdAt": "2025-01-15T10:30:00Z",
    "completedAt": "2025-01-15T11:45:00Z",
    "urls": [
      { "url": "https://example.com/page-1", "status": "completed" },
      { "url": "https://example.com/page-2", "status": "completed" }
    ]
  }
}

残高を確認#

GET/api/v1/balance30リクエスト / 60秒

現在のクレジット残高を確認します。

リクエスト例

cURL
curl https://indexbolt.com/api/v1/balance \
  -H "Authorization: Bearer ib_your_api_key"

レスポンス — 200 OK

{
  "success": true,
  "data": {
    "balance": 98,
    "unit": "credits"
  }
}

始める準備はできましたか?

アカウントを作成してAPIキーを取得すれば、数分でURLのインデックス送信を始められます。