さあ、はじめよう

ようこそ Repsona API へ！Repsona API を利用すれば、Repsona 上のタスクやノートの操作、メンバーの追加、スペース情報の更新など、Repsona に関するあらゆる操作を実行することができます。Repsona Webhook は、Repsona で発生したイベントを受信し、他のサービスやシステムとの連携に利用することができます。

Repsona API

Repsona API は REST API ライクな HTTP を基盤とした Web API です。

認証

ユーザーを識別するAPIキーを利用して、Web API リクエストを認証します。APIキーは、Repsona にログインし、ユーザー設定 > APIキー のページで取得できます。Repsona API 経由の操作は、そのユーザーが操作したものとなります。

APIキーは、他のユーザーやアプリケーションと共有したり、公開しないようにご注意ください。

リクエスト

GET クエリーパラメーターや、JSON-encoded body を利用して引数を送信することができます。APIキーは、Authorization HTTP ヘッダで送信します。

curl example

curl -X PATCH -H 'Authorization: Bearer <API key>' \
-H 'Content-type: application/json' \
--data '{"name":"Reon Walls"}' \
https://<space_id>.repsona.com/api/me

レスポンス

すべての Web API レスポンスは JSON オブジェクトを含みます。成功の場合は 200、リクエストエラーの場合は 40x、サーバーエラーの場合は 50x のステータスコードを返します。 エラーの場合、message フィールドにエラーに関するメッセージが含まれます。ログのID logId が含まれる場合もあります。

{
  "message": "Internal Server Error",
  "logId": "E84180101"
}

レート制限

スペース、または、ユーザーごとに、1分間に受付可能なリクエスト数に制限があります。リクエスト数の上限は、プランによって異なります。

リクエスト数が上限を超えた場合、429（Too many requests）が返ります。すべてのレスポンスに、レート制限に関するヘッダが含まれます。

Repsona Webhook

Repsona Webhook は、イベント通知を受信し、自動的にアクションを起動できるようにします。 タスクやノートの更新、コメントの追加、ステータスの変更などのイベントを、指定したURLに送信 (HTTPリクエスト)します。 他のサービスやシステムとの連携に利用することができます。