irucaではREST APIを提供しています。レスポンスは全てJSON形式です。
用語
- ROOM-CODE: ルームの「管理」メニューの「外部連携」にある「API利用情報」に記載の文字列です
-
例えばURLが「https://iruca.co/rooms/aaaaaaaa-bbbb-cccc-dddd-xxxxxxxxxxxx」の場合は
「aaaaaaaa-bbbb-cccc-dddd-xxxxxxxxxxxx」が「ROOM-CODE」になります
- MEMBER-ID:
メンバーリスト取得APIで取得できるメンバーごとのIDです。ルームの「管理」メニューの「外部連携」にある「API利用情報」にも記載されています
認証について
「あいことば」をルームに設定している場合、
「X-Iruca-Token」という名前のリクエストヘッダーで「APIトークン」を送ってください。
APIトークンは、ルームの「管理」メニューの「外部連携」にある「API利用情報」に記載されています。
また、あいことばを「pass」という名前で送信しても（GETの場合はクエリーストリングで）
APIの利用が可能ですが、非推奨です。リクエストヘッダーでAPIトークンを送るようにしてください
（将来的に機能として廃止する可能性があります）。
ルーム情報取得API
| HTTPメソッド |
URL |
| GET |
https://iruca.co/api/rooms/ROOM-CODE |
メンバーリスト取得API
| HTTPメソッド |
URL |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/members |
新規メンバー追加API
| HTTPメソッド |
URLとパラメーター |
| POST |
https://iruca.co/api/rooms/ROOM-CODE/members |
| name |
名前（必須） |
| status |
ステータス（必須。在席、離席など） |
| message |
ひとこと（省略可能） |
メンバー情報取得API
| HTTPメソッド |
URL |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID |
メンバー情報更新API
| HTTPメソッド |
URLとパラメーター |
| PUT |
https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID |
| name |
名前（省略可能。省略時は更新されません） |
| status |
ステータス（必須。在席、離席など） |
| message |
ひとこと（省略可能。省略時は更新されません） |
メンバー情報削除API
| HTTPメソッド |
URL |
| DELETE |
https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID |
メンバーの区切り情報取得API
| HTTPメソッド |
URL |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/member-dividers |
ステータスのカスタマイズ情報取得API
| HTTPメソッド |
URLとパラメーター |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/status-options |
| format |
「list」を指定すると戻り値が配列になります |
メンバー全員分のステータスのログ情報取得API
このAPIを利用できるのはProプランにお申し込みいただいているルームのみです。
CSVファイルに含まれる項目は、順に「日付」「時刻」「メンバーの名前」「ステータス」「ひとこと」です。
| HTTPメソッド |
URLとパラメーター |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/member-logs |
| yearmonth |
「YYYY-MM」の形式で年月を指定（必須） |
| format |
「csv」を指定してください（必須）。他の値は指定できません |
メンバーごとのステータスのログ情報取得API
このAPIを利用できるのはProプランにお申し込みいただいているルームのみです。
CSVファイルに含まれる項目は、順に「日付」「時刻」「メンバーの名前」「ステータス」「ひとこと」です。
| HTTPメソッド |
URLとパラメーター |
| GET |
https://iruca.co/api/rooms/ROOM-CODE/member-logs/MEMBER-ID |
| yearmonth |
「YYYY-MM」の形式で年月を指定（必須） |
| format |
「csv」を指定してください（必須）。他の値は指定できません |
変更履歴
- 2024年3月5日: メンバー全員分のステータスのログ情報取得APIと、メンバーごとのステータスのログ情報取得APIを追加しました。
- 2023年6月19日: メンバーの区切り情報取得APIを追加しました
- 2019年2月9日: APIトークンを利用した「あいことば」の設定されているルームの認証について記載しました
- 2018年10月10日: メンバー情報更新APIの「name」パラメーターが省略できるようになりました。省略された場合、「名前」は変更されません
- 2018年2月23日: CORS対応しました
- 2017年12月27日: ステータスのカスタマイズ情報取得APIを追加しました
- 2017年10月12日: メンバー情報更新APIの「message」パラメーターが省略された場合、「ひとこと」を更新しないように挙動を変更しました
- 2017年5月27日: 「address」「latitude」「longitude」のパラメーターを廃止しました
- 2017年5月9日: 「name_kana」のパラメーターを廃止しました
- 2016年6月23日: Basic認証を利用した「あいことば」認証を取りやめました
