SOBAミエルカクラウド API

はじめに

短い時間の間に大量にAPIへアクセスすると、一定時間利用できなくなる場合があります。 > 1リクエスト/秒程度に留めて頂けます様お願いいたします。
apikeyパラメーターはすべてのAPIに必須であり、対象となるグループを指定するキーとなります。

ミエルカクラウドにグループ管理者でログインし、[グループ管理] - [APIキー管理] から発行してください。

APIキー管理で登録した「呼び出し元サイト」がReferer リクエストヘッダーにセットされている必要があります。 例 'REFERER: https://your.site.com'

APIキーを登録したグループのユーザのemailとpasswordはすべてのAPIに必須です。
xml形式の場合はキーのアンダースコアがハイフンに置換されます
json形式の場合は値のマルチバイト文字はUnicodeエスケープシーケンスに置換されます

会議室作成API

SOBAミエルカクラウド会議室作成API は、外部からSOBAミエルカクラウドの会議室を作成するAPIです。

リクエストURL

https://cloud.soba-project.com/api/v2/create_show

リクエストメソッド

POST

リクエストヘッダ

ヘッダ名	必須
REFERER	○

POST パラメーター

パラメーター	必須	型・値	備考
apikey	○	string グループ管理者でログインし[グループ管理]-[APIキー管理]で発行	対象となるグループのapikeyであること。
email	○	string ログインアカウントのメールアドレス 254文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
password	○	string ログインアカウントのパスワード半角英数字ハッシュ化していない平文40文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
name	◯	string 作成する会議室の名前。84文字以内
xml		string 戻り値をxml形式に変更したい場合はtrueを指定	規定の戻り値はjson形式
description		string 作成する会議室の説明。340文字以内
roompassword		string 会議室に参加するためのパスワード。半角英数字ハッシュ化していない平文64字以内
start_time		string 会議を開始する日時(JST) YYYY-MM-DD hh:mm:ss形式
end_time		string 会議を終了する日時(JST) YYYY-MM-DD hh:mm:ss形式
duration		integer 会議時間	end_timeが指定されていた場合は無視される
locale		string ロケール	start_timeやend_timeをJSTで指定する場合は、"ja"を指定してください。

cURLサンプル

curl -sv -X POST -H 'REFERER: https://your.site.com' -H "Content-Type: application/json" -d '{
  "apiKey":"7341dc7f-4fe7-405f-8faf-f3ad954c26d2", 
  "email":"youraddress@soba-project.com", 
  "password":"yourpassword", 
  "name": "TestRoom",
  "description": "This is testroom",
  "start_time": "2024-08-05 10:00:00",
  "duration": 120,
  "xml": "true"
}' https://cloud.soba-project.com/api/v2/create_show

レスポンス

成功時

HTTP ステータスコード 200

成功すると、作成した会議室をJSON形式で返します

キー	型・値
created_at	datetime 作成日時
description	string 会議室の説明
id	integer 会議室ID
room_id	integer グループID
title	string 会議室名
url_guest	string ゲスト入室用URL
url_operator	string ホスト入室用URL
roompassword	string 会議室パスワードが設定されている場合のみ enable
start_time	datetime 会議開始日時 (スケジュールが設定されている場合のみ)
end_time	datetime 会議終了日時 (スケジュールが設定されている場合のみ)

エラー時

HTTP ステータスコード 500

エラー時はエラーメッセージを返します

会議室詳細

SOBAミエルカクラウド会議室詳細API は、外部からSOBAミエルカクラウドの自分の会議室情報(指定したid)を取得するAPIです。

※apikeyで指定したグループ、かつ自分が作成した会議室ではない場合は失敗します

リクエストURL

https://cloud.soba-project.com/api/v2/fetch_show

リクエストメソッド

POST

リクエストヘッダ

ヘッダ名	必須
REFERER	○

POST パラメーター

パラメーター	必須	型・値	備考
apikey	○	string グループ管理者でログインし[グループ管理]-[APIキー管理]で発行	対象となるグループのapikeyであること。
email	○	string ログインアカウントのメールアドレス 254文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
password	○	string ログインアカウントのパスワード半角英数字ハッシュ化していない平文40文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
id	◯	integer 参照する会議室のid
xml		string 戻り値をxml形式に変更したい場合はtrueを指定	規定の戻り値はjson形式

cURLサンプル

curl -X POST -H 'REFERER: https://your.site.com' -H "Content-Type: application/json" -d '{
  "apikey":"7341dc7f-4fe7-405f-8faf-f3ad954c26d2", 
  "email":"youraddress@soba-project.com", 
  "password":"yourpassword", 
  "id": 1,
  "xml": "true"
}' https://cloud.soba-project.com/api/v2/fetch_show

レスポンス

成功時

HTTP ステータスコード 200

成功すると、指定した会議室のIDをJSON形式で返します

キー	型・値
created_at	datetime 作成日時
description	string 会議室の説明
id	integer 会議室ID
room_id	integer グループID
title	string 会議室名
url_guest	string ゲスト入室用URL
url_operator	string ホスト入室用URL
roompassword	string 会議室パスワードが設定されている場合のみ enable
start_time	datetime 会議開始日時 (スケジュールが設定されている場合のみ)
end_time	datetime 会議終了日時 (スケジュールが設定されている場合のみ)

エラー時

HTTP ステータスコード 500

エラー時はエラーメッセージを返します

会議室ID一覧

SOBAミエルカクラウド会議室ID一覧API は、外部からSOBAミエルカクラウドの自分の会議室のIDをすべて取得するAPIです。

※apikeyで指定したグループ、かつ自分が作成した会議室のみを返します

リクエストURL

https://cloud.soba-project.com/api/v2/show_ids

リクエストメソッド

POST

リクエストヘッダ

ヘッダ名	必須
REFERER	○

POST パラメーター

パラメーター	必須	型・値	備考
apikey	○	string グループ管理者でログインし[グループ管理]-[APIキー管理]で発行	対象となるグループのapikeyであること。
email	○	string ログインアカウントのメールアドレス 254文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
password	○	string ログインアカウントのパスワード半角英数字ハッシュ化していない平文40文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
xml		string 戻り値をxml形式に変更したい場合はtrueを指定	規定の戻り値はjson(Array)形式

cURLサンプル

curl -X POST -H 'REFERER: https://your.site.com'  -H "Content-Type: application/json" -d '{
  "apikey":"7341dc7f-4fe7-405f-8faf-f3ad954c26d2", 
  "email":"youraddress@soba-project.com", 
  "password":"yourpassword", 
  "xml": "true"
}' https://cloud.soba-project.com/api/v2/show_ids

レスポンス

成功時

HTTP ステータスコード 200

成功すると、自分が作成した会議室のIDをArray形式で返します

エラー時

HTTP ステータスコード 500

エラー時はエラーメッセージを返します

会議室削除API

SOBAミエルカクラウド会議室削除API は、外部からSOBAミエルカクラウドの会議室を削除するAPIです。

※apikeyで指定したグループ、かつ自分が作成した会議室のみ削除できます

リクエストURL

https://cloud.soba-project.com/api/v2/delete_show

リクエストメソッド

POST

リクエストヘッダ

ヘッダ名	必須
REFERER	○

POST パラメーター

パラメーター	必須	型・値	備考
apikey	○	string グループ管理者でログインし[グループ管理]-[APIキー管理]で発行	対象となるグループのapikeyであること。
email	○	string ログインアカウントのメールアドレス 254文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
password	○	string ログインアカウントのパスワード半角英数字ハッシュ化していない平文40文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
xml		string 戻り値をxml形式に変更したい場合はtrueを指定	規定の戻り値はjson形式
id	◯	integer 削除する会議室のid

cURLサンプル

curl -X POST -H 'REFERER: https://your.site.com' -H "Content-Type: application/json" -d '{
  "apikey":"7341dc7f-4fe7-405f-8faf-f3ad954c26d2", 
  "email":"youraddress@soba-project.com", 
  "password":"yourpassword", 
  "id": "1",
  "xml": "true"
}' https://cloud.soba-project.com/api/v2/delete_show

レスポンス

成功時

HTTP ステータスコード 200

成功すると、削除した会議室をJSON形式で返します

{“description”:““,”id”:6018,“title”:“Test01”,“deleted”:true}%

キー	型・値
deleted	boolean 削除成功の場合のみtrue
id	integer 会議室ID
title	string 会議室名
description	string 会議室の説明

エラー時

HTTP ステータスコード 500

エラー時はエラーメッセージを返します

会議室更新API

SOBAミエルカクラウド会議室更新API は、外部からSOBAミエルカクラウドの会議室情報を更新するAPIです。

リクエストURL

https://cloud.soba-project.com/api/v2/update_show

リクエストメソッド

POST

リクエストヘッダ

ヘッダ名	必須
REFERER	○

POST パラメーター

パラメーター	必須	型・値	備考
apikey	○	string グループ管理者でログインし[グループ管理]-[APIキー管理]で発行	対象となるグループのapikeyであること。
email	○	string ログインアカウントのメールアドレス 254文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
password	○	string ログインアカウントのパスワード半角英数字ハッシュ化していない平文40文字以内	ミエルカクラウドにログインでき、apikeyのグループに参加していること
name	◯	string 更新する会議室の名前。84文字以内
xml		string 戻り値をxml形式に変更したい場合はtrueを指定	規定の戻り値はjson形式
id	◯	integer 更新する会議室のid
description		string 更新する会議室の説明。340文字以内
start_time		string 会議を開始する日時(JST) YYYY-MM-DD hh:mm:ss形式
end_time		string 会議を終了する日時(JST) YYYY-MM-DD hh:mm:ss形式
duration		integer 会議時間	end_timeが指定されていた場合は無視される
locale		string ロケール	start_timeやend_timeをJSTで指定する場合は、"ja"を指定してください。
noenable_schedule		boolean trueを指定すると、会議時間の予約を解除する
enable_schedule		boolean trueを指定すると、会議時間の予約する
roompassword		string 会議室に参加するためのパスワード。半角英数字ハッシュ化していない平文64字以内
noroompassword		string 会議室に参加するためのパスワードを削除する

cURLサンプル

curl -sv -X POST -H 'REFERER: https://your.site.com' -H "Content-Type: application/json" -d '{
  "apiKey":"7341dc7f-4fe7-405f-8faf-f3ad954c26d2", 
  "email":"youraddress@soba-project.com", 
  "password":"yourpassword", 
  "name": "TestRoom",
  "description": "This is testroom",
  "start_time": "2024-08-05 10:00:00",
  "duration": 120,
  "xml": "true"
}' https://cloud.soba-project.com/api/v2/update_show

レスポンス

成功時

HTTP ステータスコード 200

成功すると、更新した会議室をJSON形式で返します

キー	型・値
created_at	datetime 作成日時
description	string 会議室の説明
id	integer 会議室ID
room_id	integer グループID
title	string 会議室名
url_guest	string ゲスト入室用URL
url_operator	string ホスト入室用URL
roompassword	string 会議室パスワードが設定されている場合のみ enable
start_time	datetime 会議開始日時 (スケジュールが設定されている場合のみ)
end_time	datetime 会議終了日時 (スケジュールが設定されている場合のみ)

エラー時

HTTP ステータスコード 500

エラー時はエラーメッセージを返します