プロジェクトの状況を、安全に外部ツールへ。

1. 01
   APIキーを作成

   組織のオーナーまたは管理者が設定の「公開API」で、名前・スコープ・有効期限を指定します。

2. 02
   一度だけ表示されるキーを保管

   作成直後にコピーし、連携先のサーバー側secretへ保存します。有効期限は最長365日です。

3. 03
   Bearer認証でリクエスト

   下記の例を環境のドメインとAPIキーへ置き換えます。キーはURLへ含めません。

curl --request GET \
  --url "https://{your-sprintlog-domain}/api/public/v1/projects?per_page=20" \
  --header "Accept: application/json" \
  --header "Authorization: Bearer spl_your_token"

Base URL: https://{your-sprintlog-domain}/api/public/v1

スコープ不足は 403 Forbidden です。別組織や許可外のリソースは、IDを知っていても参照できません。 現行v1のAPIキーは組織単位で、付与したスコープに対応する社内限定データも対象です。クライアントやブラウザへ共有しないでください。

一覧レスポンス例

{
  "data": [
    {
      "id": "0197f4c1-7f51-7000-8000-000000000001",
      "key": "WEB",
      "name": "コーポレートサイト刷新",
      "status": "active",
      "start_date": "2026-08-01",
      "due_date": "2026-10-31",
      "updated_at": "2026-09-03T03:15:00Z"
    }
  ],
  "meta": {
    "current_page": 1,
    "per_page": 20,
    "total": 1,
    "last_page": 1
  }
}

404 は、存在しない対象とアクセス範囲外の対象を区別しません。422 は errors に項目別の理由を含みます。

• サーバー側で保管

  ブラウザコード、公開リポジトリ、ログ、スクリーンショットへ埋め込まないでください。

• 必要最小限のスコープ

  連携用途ごとにAPIキーを分け、不要なスコープを付与しないでください。

• APIキー毎分60件・送信元IP毎分300件

  429を受け取った場合は連続再送を避け、Retry-Afterに従って再試行してください。

• 漏えい時は直ちに失効

  共有先や保存場所を確認し、新しいAPIキーへ安全に切り替えてください。