開発環境の構築および認証情報の取得

    サンプル Bot を利用するために必要な環境設定について説明します。下記の 3 点はサンプル Bot の種類によらず必須です。

    1. LINE WORKS 認証情報の取得
    2. GitHub のリポジトリにサンプル Bot ソースコードをアップロード
    3. LINE WORKS 認証情報を用いたソースコードのアップデート

    LINE WORKS 認証情報の取得

    LINE WORKS Bot Platform API の利用にはサーバー認証が必要です。LINE WORKS Developers Console にて 以下の 3 種類の値を発行してください。

    • API ID : API を呼び出すドメインを確認するために、API 呼び出し URL に含める ID
    • Server API Consumer Key : API を呼び出す際にヘッダーに含める値。サーバー API の利用範囲を定義します。
    • Server List(ID 登録タイプ) の ID、認証キー : API を呼び出す際に用いるサーバー API トークンを発行するために必要です。

    Step 1. API ID の発行

    • API ID発行をクリックしてください。

    Step 2. Server API Consumer Key 発行及び API の利用範囲の選択

    • Server API Consumer Key の項目で 発行 をクリックすると、API の利用範囲の選択画面が表示されます。
    • 上の図にある 4 項目から、利用するサンプル Bot に応じて以下のように利用権限を選択してください。
    API の利用範囲 勤怠管理 Bot お問い合わせ Bot
    トーク Bot すべて サンプル Bot 作成及び削除 サンプル Bot 作成及び削除
    アドレス帳 すべて カレンダーの予定にメンバー名を挿入 投稿タイトルにメンバー名を挿入
    カレンダー すべて 出退勤時間を予定に登録 (不要)
    ホーム すべて (不要) Q&A 掲示板の作成、お問い合わせ内容の投稿

    • トークンの有効期間と自動延長は任意に設定できます。 継続してトーク Bot を利用するのであれば、有効期間の自動延長を有効にすることをおすすめします。

    注意

    • Service API Consumer Key と混同しないよう注意してください。

    Step 3. Server List(ID 登録タイプ) の設定

    1. Step 2 で作成した Server API Consumer Key を選択します。
    2. サーバー名は任意に設定できます。覚えやすい名前を入力してください。
    3. 保存をクリックします。
    4. 認証キーをダウンロードして保存します。

    GitHub のリポジトリにサンプル Bot ソースコードをアップロード

    サンプル Bot のソースコードは GitHub から取得します。オリジナルのソースコードをダウンロードし、自身の GitHub アカウントで非公開(Private)リポジトリ新しく作成して、ソースコードをアップロードしてから使用してください。

    • 勤怠管理 Bot GitHub:https://github.com/lineworks/samplebot_attendance_management_bot
    • お問い合わせ Bot GitHub:https://github.com/lineworks/samplebot_faq_ask_bot

    参考

    • GitHub はソースコードをアップしてソフトウェアを開発したり、他の開発者とコードを共有してプロジェクトを実行することができる開発プラットフォームです。

    ★ 重要


    • オリジナルのリポジトリを fork してインポートしないように注意してください。 オリジナルのリポジトリを fork するとソースコードを非公開(Private)に設定できません。公開(Public)リポジトリで以降の手順に従って作業を行うと、ソースコードに含まれる LINE WORKS ドメイン認証情報が第3者に公開され、個人情報漏洩等のセキュリティ問題が発生する可能性があります。

    Step 1. GitHub 上のサンプル Bot リポジトリにアクセスし、オリジナルのソースコードをダウンロード

    1. 右上の Code をクリックします。
    2. Download ZIP をクリックしてソースコードをダウンロードしてから圧縮を解除します。

    Step 2. 自身の GitHub アカウントでログインしてから画面左側の [New] をクリック

    Step 3. 新しいリポジトリを作成

    1. リポジトリの名前を入力します。
    2. Private を選択します。
    3. Create Repository をクリックします。

    Step 4. 作成したリポジトリから [uploading an existing file] を選択

    Step 5. ダウンロードしたオリジナルのソースコードをアップロード

    1. このエリアにオリジナルのソースコードのフォルダとファイルをドラッグしてアップロードします。
    2. ファイルのアップロードが完了したら、Commit changes をクリックしてください。

      参考

    Step 6. 「.locales」ファイルを作成

    注意

    • お問い合わせ Bot の環境を構築する際は、Step 6 と Step 7 をスキップしてください。お問い合わせ Bot のリポジトリに .locales ファイルを作成した場合、環境構築に失敗する可能性があります。

    1. リポジトリ右上の Add file をクリックします。
    2. Create new file をクリックします。

    Step 7. 「.locales」ファイル情報のアップデート

    1. ファイル名入力欄に「.locales」と入力します。
    2. Edit new file エリアに下記の内容をコピーしてペーストします。
      ko_KR
      ja_JP
      en_US
      ko_KR.utf8
      ja_JP.utf8
      en_US.utf8
    3. Commit new file をクリックして、ファイル情報をアップデートします。

    LINE WORKS 認証情報を用いたソースコードのアップデート

    LINE WORKS Developers Console から取得した認証情報をソースコードに反映し、サンプル Bot を利用します。

    Step 1. サンプル Bot の config.py ファイルを修正する

    1. コピーしたサンプル Bot リポジトリにて conf フォルダをクリックします。
    2. config.py ファイルをクリックします。
    3. コンソール右上の編集アイコンをクリックします。

    Step 2. config.py に認証情報を反映

    • config.py 内の #account および #api の項目を編集します。
    • ADMIN_ACCOUNT に LINE WORKS の管理者アカウントを入力します。
    • 上の図を参考に、A から E 項目まですべての項目を修正します。
    • E の SECRET_KEY_NAME には LINE WORKS Developers Consoleでダウンロードした認証キーのファイル名を入力します。

      注意

      • GitHub でソースコードを修正した後は、必ず一番下にある Commit changes をクリックしてください。コミットせずに編集を終えた場合、ソースコードに反映されません。

    Step 3. 認証キーをアップロード

    • コピーしたサンプル Bot リポジトリの初期画面に戻り、「key」フォルダをクリックします。
    • ダウンロードした認証キーを「key」フォルダにアップロードします。