keyboard_arrow_up

    LINE WORKSとの連携の設定手順

    コラボフローとLINE WORKSを連携する設定手順について説明します。

    ※LINE WORKS API 1.0の終了に伴い、LINE WORKS連携オプションの外部サービス連携設定から作成したコラボフローBotが利用できる期間は 2023年4月30日 までとなります。

    以降は、アプリディレクトリ設定（LINE WORKS API 2.0）をご利用ください。
    設定方法は、こちらからご確認ください。

    本記事の設定をおこなう前に

    事前に、コラボフローとLINE WORKSのユーザーIDが一致するようにユーザーを作成しておく必要があります。
    「LINE WORKS連携設定の事前準備 」の内容を、ご確認ならびにご設定ください。

    手順Ⅰ．各Key保存用のメモ帳をダウンロード

    連携設定では、複数のKeyやIDをコピーし、それぞれ別の場所に貼り付けます。
    コピーした各KeyやIDの一時保管に、以下のテキストファイルをご利用ください。

    使い方

    【設定手順の例】 「Console画面内で [発行] をクリックし、API ID（イ）を発行します。」

    上記のような設定手順の赤字キーワードについて、API IDを発行・コピーし、テキストファイルの「API ID（イ）」に貼り付けします。
    コラボフローLINE WORKS連携設定用メモ（例）

    手順Ⅱ．LINE WORKSとコラボフローの連携設定

    LINE WORKS側とコラボフロー側で認証情報を発行し、外部サービス連携設定で、LINE WORKS連携の設定をおこないます。

    設定のイメージ（認証情報を発行する箇所と、貼り付け先）
    参考例

    1.LINE WORKS側の認証情報を発行

    1. LINE WORKS Developer Consoleにアクセスします。

    2. LINE WORKSのログイン画面が表示されます。
      最高管理者など、Developer Consoleの利用権限を持つユーザーでログインします。

      Developer Consoleにログイン可能なユーザーについてはLINE WORKS Developers、概要ページ内の「Developer Console は誰が利用できますか？」を参照ください。
      LINEWORKSログイン画面

    3. Developer Consoleにログイン後、Console画面内の「API ID」にある [発行] をクリックし、API ID（イ）を発行します。
      発行したIDは後で利用するため、コラボフローLINE WORKS連携設定用メモの「API ID（イ）」に貼り付け、控えておきます。
      API IDの発行

    4. 同じくConsole画面内の「Server API Consumer Key」で [発行] をクリックします。

      ※同じ画面内に似た名前の「Service API Consumer Key」があります。
      　利用するのは「Server API Consumer Key」なのでご注意ください。
      Server API Consumer Keyの発行

    5. Server API Consumer Keyに与える権限設定が表示されます。
      [トークBotすべて] をONにし、[次へ] をクリックします。
      Server API Consumer Keyの権限設定

    6. Server API Consumer Keyの有効期限の設定をおこないます。

      セキュリティのため、Tokenの有効期間はなるべく短い期間が推奨されていますが、期間が過ぎるとKeyが無効になり連携が止まってしまいます。
      「Tokenの使用時に有効期間を自動延長しますか？」をONにすると、連携がおこなわれるたびに有効期間が自動延長されます。

      ただし、長期の休暇などでコラボフロー LINE WORKS連携オプションを利用しない期間が長く続くと、有効期間が更新されず、連携が止まってしまいます。
      運用を想定し、適切な有効期間を設定ください。
      Server API Consumer Keyの有効期限設定

    7. [コピー] をクリックし、Server API Consumer Key（ロ）をコピーします。
      コピーしたKeyは後で利用するため、コラボフローLINE WORKS連携設定用メモの「Server API Consumer Key（ロ）」に貼り付け、控えておきます。
      Server API Consumer Key発行済み

    8. Server IDの発行をおこなうため、Console画面内の「Server List(ID登録タイプ)」で [追加] をクリックします。

      ※同じ画面に「Server List(固定IPタイプ)」があります。
      　利用するのは「Server List(ID登録タイプ) 」なのでご注意ください。
      ServerID追加

    9. Server Listサブウインドウが表示されます。
      任意のサーバー名を入力、手順7でコピーしたServer API Consumer Key（ロ）を選択し、[保存] をクリックします。
      ServerID発行画面

    10. Server IDが発行され、認証キーファイルをダウンロードできるようになります。
      [コピー] をクリックし、Server ID（ハ）コラボフローLINE WORKS連携設定用メモの「Server ID（ハ）」に貼り付け、控えておきます。
      また、[ダウンロード] をクリックし、ダウンロードした認証キーファイル（二）を、PCの任意のフォルダに保存します。
      ServerID発行済み

    11. 画面の左にある、「Console」サイドメニューの一番下に表示されているDomain ID（ホ）を、コラボフローLINE WORKS連携設定用メモの「Domain ID（ホ）」に貼り付け、控えておきます。
      Domain IDの表示

    2. コラボフロー側の認証情報を発行

    1. コラボフローにシステム管理者のアカウントでログインします。

    2. 画面上部の歯車アイコンから、システム管理エリアにアクセスします。

    3. 上部のナビゲーションメニューから [環境設定] をクリックし、環境設定を表示します。

    4. 「REST API」セクションの下部にある「登録」の「クライアント名」に任意の名前を入力し、認証タイプに「HTTPヘッダー認証」を選択、[APIキーを発行する] をクリックしてAPIキーの発行します。

      発行したAPIキー（へ）を、コラボフローLINE WORKS連携設定用メモの「APIキー（へ）」に貼り付け、控えておきます。
      コラボフローREST APIキー発行

    3.外部サービス連携設定にログイン

    1. 外部サービス連携設定にアクセスします。

    2. 初回はログイン画面が表示されます。
      コラボフローのインスタンス名と、システム管理者のユーザーID、パスワードを入力し、ログインします。

      ※ {インスタンス名} は、個社毎の固有の部分です。
      　コラボフローのURLで確認する場合、
      　「https://cloud.collaboflow.com/{インスタンス名}/」
      　の {インスタンス名} 部分がインスタンス名です。
      外部サービス連携設定へのログイン

    3. ログインすると、外部サービス連携設定のTOP画面が表示されます。
      外部アプリ外部サービス連携設定のTOP

    4. TOP画面から「LINE WORKS」メニューをクリックし、設定画面に移動します。

    4.外部サービス連携設定「コラボフロー設定」

    1. LINE WORKSの連携設定画面で「コラボフロー設定」タブをクリックします。

    2. コラボフローのAPIキー（ヘ）を入力し、[保存] をクリックします。
      保存が正常に完了すると、[Webhook用のURLをコピー] のボタンが表示されます。
      外部サービス連携設定 コラボフローの連携設定

    3. [Webhook用のURLをコピー] をクリックしてコピーしたWebhook用のURL（ト）を、コラボフローLINE WORKS連携設定用メモの「Webhook用のURL（ト）」に貼り付け、控えておきます。
      外部サービス連携設定 コラボフローの連携設定保存後

    5.外部サービス連携設定「認証コード」

    ※「認証コード」は、コラボフロー LINE WORKS連携オプションの契約時に発行されます。
    　ご契約開始時にコラボスタイルからお送りしますメールにて、ご確認ください。
    ※お試し中の場合、「認証コード」は未登録のまま連携設定をおこないます。

    1. LINE WORKSの連携設定画面で「認証コード」タブをクリックし、設定画面に移動します。

    2. コラボフロー LINE WORKS連携オプション契約時に発行される「認証コード」を入力し、[保存] をクリックします。
      外部サービス連携設定 LINE WORKS認証コード入力

    6.外部サービス連携設定「認証情報」

    1. LINE WORKSの連携設定画面で「認証情報」タブをクリックし、以下の認証情報を入力します。

      API ID API ID（イ）を入力します。
      Server API Consumer Key Server API Consumer Key（ロ）を入力します。
      Server ID Server ID（ハ） を入力します。
      Domain名 Domain ID（ホ）を入力します。
      認証キー 「認証キー」エリアに認証キーファイル（ニ）をドラッグ＆ドロップ、または「認証キー」エリアをクリックして認証キーファイル（ニ）を選択し、アップロードします。

    2. [保存] をクリックします。
      外部サービス連携設定 LINE WORKS認証設定

    7.外部サービス連携設定「トークBOTS」

    1. LINE WORKSの連携設定画面で「トークBOTS」タブをクリックします。

    2. [ボットを登録する] をクリックします。
      外部サービス連携設定 LINE WORKSボットを登録する

    3. 以下の情報を入力します。

      コラボフロー App CD トークBotと連携する、コラボフローアプリのApp CDを入力します。
      ※コラボフロー App CDは、コラボフローアプリのTop画面のURLで確認します。

      例：https://cloud.collaboflow.com/{インスタンス名}/index.cfm?app_cd=1
      の場合、コラボフロー App CDは「1」です。
      LINE WORKS Domain ID Domain ID（ホ）を入力します。
      LINE WORKS Bot名 LINE WORKS側で表示されるBot名を指定します。
      LINE WORKS 担当者 トークBotの管理者を指定します。
      LINE WORKSに登録している、メンバーのユーザーIDを入力します。

      ※LINE WORKS 担当者には、必ず1名登録する必要があります。（最大3名まで登録できます。）

    4. [登録] をクリックすると、LINE WORKSにトークBotが作成されます。
      LINE WORKSのサービス通知で、トークBotが作成されたことが通知されます。
      ※サービス通知はLINE WORKS上の全ユーザーに通知されます。

    手順Ⅲ．コラボフローでWebhookを設定

    LINE WORKSと連携したいコラボフローの対象経路でWebhookを設定します。

    1. コラボフローにシステム管理者、または対象アプリの設定権限を持つユーザーのアカウントでログインします。

    2. アプリ設定から経路設定にアクセスします。

    3. 対象の経路を開き、「Webhook」タブをクリックします。

    4. [新規登録] をクリックし、Webhookの設定ウインドウで以下の設定情報を入力します。
      コラボフローWebhookの設定

      Webhook名 Webhookの名前を入力します。
      通知先のWebhook URL Webhook用のURL（ト）を入力します。
      通知条件 Webhook通知をおこなうイベントを指定します。
      コラボフロー LINE WORKS連携オプションで対応している、以下5つをONにします。
      ・受信時
      ・却下時
      ・否認時
      ・差し戻し時
      ・申請書の経路終了時に通知する

      Webhook通知の詳細については「経路のWebhook通知について」をご確認ください。
      メモ 備忘録のためのメモです。必要に応じて入力します。
      このWebhookを有効にする チェックをONにします。

    5. [保存] をクリックします。

    システム管理者でおこなう設定はここまでです。

    次は、各ユーザーがLINE WORKSで新規のトークルームを作成し、コラボフローBotを招待します。
    設定については、「コラボフローBotの設定と利用方法」をご確認ください。

    連携設定の解除方法

    外部サービス連携設定＞LINE WORKS＞LINE WORKS連携設定＞「コラボフロー設定」タブ の下部にある [連携設定を解除] から、コラボフローとLINE WORKSの連携を解除できます。
    外部サービス連携設定 連携の解除

    [連携設定を解除] をクリックすると、連携解除の確認画面が表示されます。
    削除して問題ないか確認の上、[削除] をクリックします。

    ※連携を解除すると、トークBotも含めた連携情報が削除されますので、ご注意ください。
    外部サービス連携設定 連携の解除確認

    補足

    LINE WORKS連携設定の認証コードを未登録の場合

    • 「認証コード」を未登録の場合、コラボフローBotのメッセージに「【お試し中】」が表示されます。

    • お試し中に連携設定をおこない、お試し中に利用したコラボフローとLINE WORKSの環境をご契約後もそのまま利用する場合は、以下の手順で認証コードを設定すると、トークBotのメッセージに「【お試し中】」が表示されなくなります。

    1. 外部サービス連携設定＞LINE WORKS＞LINE WORKS連携設定＞「認証コード」タブを表示します。
    2. コラボフロー LINE WORKS連携オプション契約時に発行される「認証コード」を入力し、[保存] をクリックします。

    注意点

    • 外部サービス連携設定が、スマートフォン版ブラウザーで正常に操作できない場合、PC版のブラウザーから操作をおこなってください。

    • 手順Ⅱ－2－4で発行した「REST API」の「APIキー（へ）」を変更し、連携設定に利用する「REST API」のAPIキーを変更する場合は、以下の手順で「Webhook用のURL（ト）」も保存しなおしてください。

    1. 外部サービス連携設定の「コラボフロー設定」タブで、変更後のAPIキー（ヘ）を貼りなおし、[保存] をクリックします。
    2. 1と同タブの画面にある [Webhook用のURLをコピー] をクリックして、Webhook用のURL（ト）をコピーします。
    3. コラボフローの対象経路の「Webhook」タブの設定画面で、「通知先のWebhook URL」に、手順2でコピーしたWebhook用のURL（ト）を貼りなおして保存します。

    関連記事

    この記事の内容