APIリファレンス
URLインデックスAPIドキュメント
IndexBoltのURLインデックスAPIを使えば、URLをGoogleにインデックス送信し、送信進捗を追跡し、クレジットをプログラムから管理できます。一括URLインデックスをSEOワークフロー、WordPressプラグイン、独自ツールに組み込みましょう。
ベースURL:
https://indexbolt.com/api/v1•JSONリクエスト&レスポンス•Bearerトークン認証認証#
すべてのAPIリクエストには、AuthorizationヘッダーにBearerトークンが必要です。APIキーはダッシュボード設定から生成できます。
リクエストヘッダーの例
Authorization: Bearer ib_your_api_key_here重要: APIキーは
ib_プレフィックスで始まります。キーは秘密にしてください。クライアントサイドのコードに露出させないでください。1アカウントにつき最大5つのAPIキーを作成できます。レート制限#
レート制限は、スライディングウィンドウ方式でAPIキーごとに適用されます。レート制限がかかった場合は、429ステータスコードを受け取ります。
| エンドポイント | 制限 | 期間 |
|---|---|---|
POST /submit | 10リクエスト | 60秒 |
GET /balance | 30リクエスト | 60秒 |
GET /submissions, /submissions/:id | 60リクエスト | 60秒 |
レスポンスヘッダーX-RateLimit-RemainingとX-RateLimit-Resetで現在の使用状況を確認できます。
エラー処理#
すべてのエラーは一貫したJSON構造で返されます。
{
"success": false,
"error": {
"code": "ERROR_CODE",
"message": "Human-readable description"
}
}| HTTPステータス | コード | 説明 |
|---|---|---|
400 | INVALID_INPUT | リクエストボディまたはパラメータが不正です |
401 | UNAUTHORIZED | APIキーがないか無効です |
402 | INSUFFICIENT_CREDITS | 操作に必要なクレジットが不足しています |
403 | FORBIDDEN | メールが認証されていません |
404 | NOT_FOUND | リソースが見つかりません |
429 | RATE_LIMITED | リクエストが多すぎます |
500 | INTERNAL_ERROR | 予期しないサーバーエラー |
クレジットと料金#
通常インデックス
1 クレジット / URL
標準処理。URLをGoogleにインデックス送信します。
インスタントインデックス
10 クレジット / URL
インデックスを高速化する優先処理。
クレジットに有効期限はありません。1回の送信には1〜1,000件のURLを含められます。無効なURLは除外され、クレジットは消費されません。
URLを送信#
POST
/api/v1/submit10リクエスト / 60秒URLのバッチをGoogleにインデックス送信します。
リクエストボディ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
urls | string[] | 必須 | インデックスするURLの配列(1〜1,000件) |
indexingType | string | 必須 | 「normal」または「instant」 |
projectId | string | 任意 | プロジェクトに紐付け |
submissionName | string | 任意 | 送信のカスタム名 |
リクエスト例
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秒送信のページネーション付きリストを取得します。
クエリパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
page | integer | 任意 | ページ番号(デフォルト:1) |
pageSize | integer | 任意 | 1ページあたりの結果数、最大100(デフォルト:20) |
status | string | 任意 | 「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ごとのステータスを含む、送信の詳細を取得します。
パスパラメータ
| パラメータ | タイプ | 必須 | 説明 |
|---|---|---|---|
id | string | 必須 | 送信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"
}
}