API仕様ドキュメント
認証、レート制限、主要エンドポイントの概要です。ベースURLはhttps://api.nyusatsu.aiを想定しています。
認証フロー
- Googleでログイン
- Starter/Pro プランを選択して決済
- Dashboard または
/api/v1/me/api-keysでAPIキーを発行 - リクエストヘッダー
X-API-Keyにキーを付与してAPIを実行
curl "https://api.nyusatsu.ai/api/v1/bids?keyword=クラウド&limit=5" \ -H "X-API-Key: napi_your_key_here"
レート制限
- 1分間上限: 未認証/`pending` は 10 req/min、`starter`/`pro` は 100 req/min
- 日次上限: `pending` は 100 req/day、`starter` は 5,000 req/day、`pro` は無制限
レスポンスには X-RateLimit-Limit / X-RateLimit-Remaining / X-RateLimit-Reset と、日次クォータ用の X-DailyQuota-Limit / X-DailyQuota-Remaining / X-DailyQuota-Reset が含まれます。上限超過時は 429 Too many requests を返します。
エンドポイント概要
リクエスト/レスポンスをブラウザ上で試す場合は インタラクティブAPIリファレンス（Scalar）を開く。
| Method | Path | 認証 | 概要 |
|---|---|---|---|
| GET | /api/v1/bids | 任意 | 入札データ検索（ページング/カーソル対応） |
| GET | /api/v1/bids/:id | 任意 | 入札詳細を1件取得 |
| POST | /api/v1/bids/export | 必須 | 検索条件に一致する入札をCSVでエクスポート |
| GET | /api/v1/agencies | 任意 | 発注機関一覧を取得 |
| GET | /api/v1/stats | 任意 | 全体統計を取得 |
| GET | /api/v1/stats/summary | 任意 | 日別サマリーを取得 |
| POST | /api/v1/billing/checkout | 必須 | Stripe Checkout URL を生成 |
| POST | /api/v1/billing/portal | 必須 | Stripe Customer Portal URL を生成 |
| GET | /api/v1/alerts | 必須 | アラート一覧取得（作成/更新/削除APIあり） |
| GET | /api/v1/me | セッション必須 | ログイン中ユーザー情報を取得 |
| POST | /api/v1/me/api-keys | セッション必須 | APIキー発行/ローテーション/失効 |
主要エンドポイントのレスポンス例
入札検索/api/v1/bids
キーワード検索付きのページングレスポンス
curl "https://api.nyusatsu.ai/api/v1/bids?keyword=クラウド&limit=2" \ -H "X-API-Key: napi_your_key_here"
Response (200 OK)
{
"bids": [
{
"id": "BID-2024-0001",
"title": "クラウド環境構築業務",
"agency": "内閣府",
"date": "2024-01-15",
"amount": 1200000,
"winner": "株式会社テスト",
"url": "https://example.com/bids/BID-2024-0001",
"category": "役務"
}
],
"nextCursor": "cursor_next_example",
"total": 120,
"page": 1
}入札詳細/api/v1/bids/:id
単一の入札詳細レスポンス
curl "https://api.nyusatsu.ai/api/v1/bids/BID-2024-0001" \ -H "X-API-Key: napi_your_key_here"
Response (200 OK)
{
"id": "BID-2024-0001",
"title": "クラウド環境構築業務",
"agency": "内閣府",
"date": "2024-01-15",
"amount": 1200000,
"winner": "株式会社テスト",
"url": "https://example.com/bids/BID-2024-0001",
"category": "役務"
}発注機関一覧/api/v1/agencies
機関一覧のページングレスポンス
curl "https://api.nyusatsu.ai/api/v1/agencies?limit=2" \ -H "X-API-Key: napi_your_key_here"
Response (200 OK)
{
"agencies": [
{
"name": "内閣府",
"bid_count": 231
},
{
"name": "総務省",
"bid_count": 198
}
],
"nextCursor": "cursor_agency_next_example"
}全体統計/api/v1/stats
統計レスポンス（キーは実装に応じて変動）
curl "https://api.nyusatsu.ai/api/v1/stats" \ -H "X-API-Key: napi_your_key_here"
Response (200 OK)
{
"total_bids": 12345,
"total_amount": 9876543210,
"agency_count": 320
}