irucaではREST APIを提供しています。どうぞご利用ください。

用語

  • ROOM-CODE: ルーム設定のページの最下部に記載されている文字列です
    • 例えばURLが「https://iruca.co/rooms/aaaaaaaa-bbbb-cccc-dddd-xxxxxxxxxxxx」の場合は 「aaaaaaaa-bbbb-cccc-dddd-xxxxxxxxxxxx」が「ROOM-CODE」になります
  • MEMBER-ID: メンバーリスト取得APIで取得できるメンバーごとのIDです

認証について

「あいことば」がルームに対して設定されている場合、 その「あいことば」を「pass」という名前で送信してください(GETの場合はクエリーストリングで)。 送信された「あいことば」が正しい場合、同一セッションの間有効になります。

ルーム情報取得API

メソッド URL
GET https://iruca.co/api/rooms/ROOM-CODE

メンバーリスト取得API

メソッド URL
GET https://iruca.co/api/rooms/ROOM-CODE/members

新規メンバー追加API

メソッド URLとパラメーター
POST https://iruca.co/api/rooms/ROOM-CODE/members
name 名前
status ステータス(在席、離席など)
message ひとこと(省略可能)

メンバー情報取得API

メソッド URL
GET https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID

メンバー情報更新API

メソッド URLとパラメーター
PUT https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID
name 名前
status ステータス(在席、離席など)
message ひとこと(省略可能)

メンバー情報削除API

メソッド URL
DELETE https://iruca.co/api/rooms/ROOM-CODE/members/MEMBER-ID

変更履歴

  • 2017年5月27日: 「address」「latitude」「longitude」のパラメーターを廃止しました
  • 2017年5月9日: 「name_kana」のパラメーターを廃止しました
  • 2016年6月23日: Basic認証を利用した「あいことば」認証を取りやめました