一般ユーザーAPIの概要

一般ユーザーAPIは、各ユーザーが個人で発行するAPIアクセスキーを利用するAPIです。

一般ユーザーAPIには、以下のAPIが存在します。

カテゴリ	API名
一覧取得系API	ユーザー所属ルーム一覧取得API
メッセージ投稿系API	マイルームメッセージ投稿API
	ユーザー所属ルームメッセージ投稿API
システム通知投稿系API	マイルーム通知投稿API

APIのアクセス権限について

システム管理者が許可しているAPIのみ利用できます。

リクエスト先のURL

お客様の環境によって異なりますので、環境に合わせたURLをご利用ください。

ご利用パッケージ	リクエスト先のURL
Linux版	http://(your.domain)/cgi-bin/chatlk/userApi.cgi または https://(your.domain)/cgi-bin/chatlk/userApi.cgi
Windows版	http://(your.domain)/scripts/chatlk/userApi.exe または https://(your.domain)/scripts/chatlk/userApi.exe

※ 「(your.domain)」は、お客様の環境に読み替えてください。

※ 本URLは標準インストールした場合です。インストール先が異なる場合は読み替えてください。

V6.8R1.1以前でシステム通知投稿系API(chatPushMessageモジュールを使ったAPI)をご利用になっていた場合

chatPushMessageモジュールは廃止予定のため非推奨となります。
userApiモジュールの利用をご検討ください。

例：
変更前：https://(your.domain)/cgi-bin/chatlk/chatPushMessage.cgi
変更後：https://(your.domain)/cgi-bin/chatlk/userApi.cgi

APIを利用するための準備

個人のAPIアクセスキーの取得方法

一般ユーザーAPIを利用するには、APIアクセスキーを取得する必要があります。
※ APIアクセスキーを取得するには、システム管理者が個人でのAPIアクセスキーの発行を許可している必要があります。
　 許可されていない場合は取得できません。

1. 個人設定画面を表示します。
2. 左側のメニューから「外部サービス連携設定」の「APIアクセスキー設定」を選択して、
   APIアクセスキー設定画面を表示します。
3. 「APIアクセスキーの利用」の項目の「発行」ボタンをクリックします。
4. 「APIアクセスキーの利用」の項目を「利用する」に変更します。
5. 「変更」ボタンをクリックします。（クリックすると設定状況画面が表示されます。）
6. もう一度、APIアクセスキー設定画面を表示します。
7. 「APIアクセスキー」の項目に表示されているAPIアクセスキーをコピーして取得します。