Lead Manager Public API Documentation

認証

APIキーを使用してリクエストを認証します。以下のいずれかの方法でAPIキーを送信してください：

Authorization: Bearer sk_live_your_api_key
X-API-Key: sk_live_your_api_key
?api_key=sk_live_your_api_key

エンドポイント

POST /public-api/leads

新しいリードを作成します

リクエスト例:

{
  "contact_name": "田中太郎",
  "company_name": "株式会社サンプル",
  "email": "tanaka@sample.co.jp",
  "phone": "03-1234-5678",
  "position": "営業部長",
  "score": 75,
  "source": "ウェブサイト",
  "estimated_value": 500000,
  "expected_close_date": "2025-12-31",
  "notes": "問い合わせフォームからの登録"
}

GET /public-api/leads

リード一覧を取得します（leads:read権限が必要）

パラメーター: page, limit, status, source

GET /public-api/leads/:id

特定のリードの詳細を取得します（leads:read権限が必要）

PUT /public-api/leads/:id

リード情報を更新します（leads:update権限が必要）

レート制限

各APIキーは1分間に100リクエストまで利用できます。レート制限に達した場合は429ステータスコードが返されます。

レスポンスヘッダー

X-RateLimit-Limit: 制限値
X-RateLimit-Remaining: 残りリクエスト数
X-RateLimit-Reset: リセット時刻（Unix timestamp）

エラーレスポンス

401 Unauthorized APIキーが無効または未提供

403 Forbidden 権限不足

429 Too Many Requests レート制限に達しました

500 Internal Server Error サーバーエラー