API リファレンス
Repsona API を使うと、タスクやノートの操作、メンバーの追加、スペースの情報の更新など、Repsona の操作をほかのシステムから行えます。
Repsona Webhook では、Repsona で起きた出来事を受け取って、ほかのサービスやシステムと連携できます。
認証
API キーでリクエストを認証します。API キーは、Repsona にログインして「ユーザー設定 > APIキー」で作れます。
API で行った操作は、キーを作ったユーザーの操作になります。
ヘッダー
Authorization: Bearer <API キー>リクエスト
スペースの URL に、各 API のパスを続けます。
https://<space>.repsona.com/api/...GET はクエリーパラメーター、POST・PATCH などは JSON のボディで値を送ります。
例
curl -X PATCH "https://<space>.repsona.com/api/me" \
-H "Authorization: Bearer $REPSONA_API_KEY" \
-H "Content-Type: application/json" \
-d '{"fullName":"Reon Walls"}'レスポンス
レスポンスはすべて JSON です。成功したときは 2xx、リクエストの誤りは 4xx、サーバーのエラーは 5xx を返します。
エラーのときは、error.code と error.message に内容が入ります。お問い合わせの際は requestId を添えてください。
エラーの例
{
"ok": false,
"requestId": "cm3x9k2h40001qz8f7a1b2c3d",
"statusCode": 404,
"error": {
"code": "NOT_FOUND",
"message": "Not Found"
}
}レート制限
1 分あたりに受け付けるリクエストの数に、ユーザーごとの上限があります。読み取り (GET) と書き込みは別々に数えます。
| プラン | 読み取り | 書き込み |
|---|---|---|
| Free | 1,000 回 / 分 | 150 回 / 分 |
| Standard | 2,000 回 / 分 | 150 回 / 分 |
上限を超えると 429 (Too Many Requests) を返します。どのレスポンスにも、レート制限のヘッダーが付きます。
RateLimit-Limit- この 1 分の上限
RateLimit-Remaining- この 1 分の残りの回数
RateLimit-Reset- 上限がリセットされるまでの秒数
レスポンスのヘッダー
HTTP/1.1 200 OK
RateLimit-Limit: 2000
RateLimit-Remaining: 1999
RateLimit-Reset: 42画面の URL
API の ID から、Repsona の画面の URL を作れます。ブラウザで開くと、その画面が開きます。
- プロジェクト
/p/{projectId}- タスク
/p/{projectId}/task/{taskId}- ノート
/p/{projectId}/note/{noteId}- ガントチャート
/p/{projectId}/gantt
旧形式の /id-link/... の URL も、同じ画面に移ります。
例
https://<space>.repsona.com/p/{projectId}
https://<space>.repsona.com/p/{projectId}/task/{taskId}
https://<space>.repsona.com/p/{projectId}/note/{noteId}
https://<space>.repsona.com/p/{projectId}/ganttWebhook
Repsona Webhook は、タスクやノートの更新、コメントの追加、ステータスの変更などが起きたときに、指定した URL へ HTTP リクエストを送ります。設定は、プロジェクトの設定の「Webhook」で行います。
Webhook の仕様を見る