REST APIリファレンス
一括インデックスチェックを、独自のダッシュボード、ツール、スクリプトに直接組み込めます。高スループットのAPIでSEOワークフローを自動化しましょう。
IndexCheckerのREST APIを使うと、独自のスクリプトやダッシュボードからチェックプロジェクトの作成、インデックス状況の取得、クレジット残高の確認ができます。リクエストはすべてPOST本文内の秘密のAPIキーで認証され、エンドポイントはJSONを返します。1プロジェクトで最大50,000 URLまで扱え、1クレジットで1 URLを確認できます。
IndexChecker APIにはどのエンドポイントがありますか？
| エンドポイント | 方法 | 用途 |
|---|---|---|
| /api/project/create | POST | URLリストからチェックプロジェクトを作成 |
| /api/project/show | POST | プロジェクトのステータス、統計、リンクを取得 |
| /api/project/show_all | POST | すべてのプロジェクトを一覧表示 |
| /api/project/delete | POST | プロジェクトを完全に削除 |
| /api/check-balance | POST | 現在のクレジット残高を取得 |
認証
リクエスト本文（POSTパラメータ）に秘密のAPIキーを含めて、リクエストを認証します。
APIキーはダッシュボードの設定で確認、管理できます。
セキュリティに関する注意：APIキーは安全に保管してください。公開されているコード（クライアント側のJSなど）に含めて共有しないでください。
プロジェクトの作成
URLリストを指定して新しいチェックプロジェクトを作成します。
秘密のAPIキー。
プロジェクト名。
パイプ記号|で区切ったURLのリスト。
-d "apikey=YOUR_API_KEY" \
-d "project_name=MyProject" \
-d "urls=https://site1.com|https://site2.com"
"error": 0,
"message": "project MyProject has been added in it 2 links.",
"project_name": "MyProject",
"procjet_id": 154,
"project_id": 154,
"add_links_count": 2
}
プロジェクトの詳細を取得
特定のプロジェクトのステータス、統計、リンクを取得します。
取得したいプロジェクトのID。
"project_name": "MyProject",
"description": "optional description",
"date_created": "2023-10-12 14:30:00",
"project_id": "154",
"urls": {
"https://site1.com": "1",
"https://site2.com": "-1"
},
"statistics": {
"total_links": 2,
"indexed": 1,
"not_indexed": 0,
"pending": 1,
"percentage": 50
}
}
全プロジェクトの一覧
すべてのプロジェクトの一覧を取得します。
"154": {
"project_name": "MyProject",
"description": "",
"date_created": "2023-10-12 14:30:00"
},
"155": {
"project_name": "Another Project",
"description": "SEO Audit",
"date_created": "2023-10-13 09:15:00"
}
}
プロジェクトの削除
プロジェクトと関連するすべてのデータを完全に削除します。
削除するプロジェクトのID。
"id": "154",
"error": 0,
"message": "The MyProject project has been deleted"
}
残高の確認
現在のクレジット上限を取得します。
"limit": 4500,
"error": 0
}
よくある質問
APIリクエストはどのように認証しますか？
各リクエストのPOST本文に、秘密のAPIキーをapikeyパラメータとして含めてください。キーはダッシュボードの設定で確認、管理できます。
1つのAPIプロジェクトに含められるURLはいくつですか？
1プロジェクトあたり最大50,000件で、ダッシュボードと同じ上限です。プロジェクトを作成するときは、urlsパラメータ内でパイプ記号を使って区切ります。
APIでのチェックにはいくらかかりますか？
確認したURLごとに1クレジットで、2つ目のデータセンターでの再確認も含まれます。クレジットに有効期限はなく、無料トライアルを含むすべてのプランでAPIを利用できます。
APIはどの形式で応答しますか？
JSONです。各エンドポイントは、成功時に0となるerrorフィールドと、プロジェクトのデータ（ステータス、統計、必要に応じてURLごとのインデックス結果）を返します。
IndexCheckerは、ポーランドのCzerwinに本社を置くEU登録企業AP2Media Sp. z o.o.（VAT ID PL7582396091）が運営するGoogle一括インデックスチェッカーです。同社自身のSEOプロジェクト（ローカルSEOサービスのdrukujemy3d.plなど）で実際に使われており、過去30日間で顧客のために200万件以上のURLを検証しました。