Skip to content

システム管理者APIの概要

システム管理者APIは、システム管理者が発行するAPIアクセスキーを利用するAPIです。

システム管理者APIには、以下のAPIが存在します。

カテゴリAPI名
一覧取得系API全ユーザー一覧取得API
全ルーム一覧取得API
システム通知投稿系APIマイルーム通知投稿API
ルーム通知投稿API
コンタクト通知投稿API

リクエスト先のURL

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

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

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

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

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

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

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

APIを利用するための準備

システム管理者のAPIアクセスキーの取得方法

システム管理者APIを利用するには、APIアクセスキーを取得する必要があります。

  1. システム管理者権限のユーザーでログインして、システム管理者設定画面を表示します。
  2. 左側のメニューから「外部サービス連携設定」の「APIアクセスキー管理」を選択して、
    APIアクセスキー管理画面を表示します。
  3. APIアクセスキーを追加します。
  4. 左側のメニューから「外部サービス連携設定」の「APIアクセスキー管理」の「APIアクセスキー一覧」を選択して、
    APIアクセスキー一覧画面を表示します。
  5. 追加したAPIアクセスキーの「コピー」を行うことでAPIアクセスキーを取得します。