はじめに
LINE WORKS Advent Calendar 2022 12日目です。
この度はお集まりいただきありがとうございます。
タイトルの通り、今回はLINE WORKSのAPIを使った初心者向けの記事を書こうと思います。
LINE WORKSのAPIといえば、今年の4月にバージョン1.0から2.0へとアップデートしてことは記憶に新しいですよね。
▼「LINE WORKS」のAPI2.0を提供開始
https://line.worksmobile.com/jp/pr/20220404/
LINE WORKS APIのBotを登録するをハンズオン？形式で実践していきます。
これからLINE WORKS APIを触ってみようと思っている方向けの励みになればと思います。
環境の用意
postmanのインストール
冒頭でもお伝えしましたが、今回はpostmanというツールを使った方法で実践していきます。
postmanは簡単にAPIのリクエストを試すことができる画期的なツールです。
postmanは以下のダウンロードページからダウンロードできます。（windows以外のOSの方はそれぞれのものを使ってね）
https://www.postman.com/downloads/
postmanを起動する
postmanが無事にインストール出来たら、英語よくわからない文字が書かれていると思います。
まずはAPIを実行するためのワークスペースを用意します。
トップページの左上あたりにworksspacesというボタンがあるので、そちらをクリック。
そしてCreate Workspaceで作成。
Worksapaceの名前などは各自で設定ください。
最後にcreateだ。
LINE WORKSの環境を用意
LINE WORKSのアカウントの用意は割愛するが、
HPから無料の環境を作成することができます。
▼HP
https://line.worksmobile.com/jp/
LINE WORKS Developer Consoleでの設定
以下のリンクからDeveloper Consoleにアクセスします。
そしてまずは、アプリの新規作成でアプリを追加する必要があります。
作成すると、ClientIDとClient Secretという欄があるかと思います。
こちらは後ほど、認証を通すために使用しますので、メモ帳か何かに控えておくと良いです。
また、Redirect URLは任意のURLを設定ください。
保存すると無事に先ほどのRedirect URLが表示されているのが確認できます。
LINE WORKSには認証方法が2つありますが、今回はOAuthという認証を使ってAPIを実行してみようと思います。
なぜこの認証が必要なの？という質問が上がるかもしれないですが、ここでは割愛します。
（決して面倒くさいというわけではない・・・・・）
OAuth Scopesで「bot」という箇所を選択してください。
ここでは様々なScopesが選択できますので、APIの公式リファレンスに基づいたものを選択する必要があります。
これで長い設定が一通り完了です。
ここまで来たらあとは認証を通して実行するだけです！あと少し頑張りましょう。
postmanで実行する
アクセストークンを取得する
先ほど、postmanでWorkspaceを作成したかと思います。
もう一度postmanのアプリケーションに戻ってきてください。
そしてページ上の方にある「New」というところをクリックしてください。
「New」をクリックするとこんなモーダルが出てくると思います。
今回はHTTP通信で試してみますので、左上のHTTP Requestをクリックしてください。
HTTP Reqestをクリックすると画面が少し変わると思います。
デフォルトでは画像のようにParamsのタブが開いていると思いますが、その隣のAuthorizationというところをクリックしてください。
認証情報のTypeを選択するボックスがありますが、ここではOAuth2.0を選択ください。
クリックするとCurrent Tokenという画面が右側に表示されたかと思いますので、
必要な情報を入力していきます。
AuthURL、Access Token URLには公式リファレンスからの引用ですが、
以下の情報を入力してください。
Authorization URL - https://auth.worksmobile.com/oauth2/v2.0/authorize
Token URL - https://auth.worksmobile.com/oauth2/v2.0/token
また、、ClientIDとClient Secretには先ほどのDevelopper Consoleで取得してきた文字をぶち込んでください。
Scopeの項目には「bot」と入力してください。
後は画像の通り選択、入力してみてください。
必要な項目を入力した後、ちょっとわかりにくいですが、
ページの下の方にある「Get New Access Token」というオレンジ色のボタンを押してください。
そうすると、LINE WORKSのロゴが入ったログイン画面が表示されたモーダルが出てくるかと思います。
ここにはLINE WORKSの管理権限のあるユーザーでログインしてください。
成功すると、以下のようなモーダルに切り替わります。
このまま右下の「Proceed」をクリックしてください。
この時点でLINE WORKS APIを実行するためのアクセストークンが手に入っている状態です。
アクセストークンはかならず必要になるので、取得しておきましょう。
オレンジ色の「Use Token」で使用することができます。
APIを実行する
アクセストークンを取得してことですし、
実際にAPIを実行していきましょう。あとひと踏ん張り！！
今回は、公式リファレンスのBOTの登録というAPIを実行しますので、
公式に従って メソッド とURL を入力します。
リファレンスにもある通り、リクエストBodyというものが必要になります。
具体的には、
- ボットの名前
- ボットの説明
- ボットプロフィール画像のURL
などがリクエストBodyに乗せることができます。
下の方のBody→rawと選択し、右側の「Text」とある個所は「JSON」に変更してください。
ここでリクエストするための必要項目をJSON形式で指定していきます。
そしてリクエストするためのJSONを書きます。
私はよく洗濯機を回し忘れてよく怒られるので、洗濯機を回すように催促してくれるBotを作成します。
administratorsは必須ですので、ご自身のユーザーID（example@example.co.jp）を入力してください。
そして最後にSENDだ！！！（右上の青いボタン）
成功していると応答が返ってきます。
再度、Developper Consoleに入り、Botというところをクリックしてください。
無事に成功しているとボットが作成できていると思います。
長かったですね。お疲れさまでした。
最後に
いかがだったでしょうか？
もしもわかりづらい点などがございましたらコメント欄にてお願いいたします
最後に少し宣伝！！！！
10/24に名古屋でLWTTというコミュニティを開催しました。
次回は2月ごろを予定しておりますので、
ちょっとでも興味のある方、ぜひぜひ足を運んでください！！
それではまた。