ラベル LINE の投稿を表示しています。 すべての投稿を表示
ラベル LINE の投稿を表示しています。 すべての投稿を表示

2023年2月28日火曜日

LINE公式アカウントから返信および受信した写真を保存する

 LINE Messaging APIを発行するためのWeb資格証明の作成方法について、以前の記事で紹介しています。折角なので、この記事で作成したWeb資格証明(静的識別子はLINE_CHANNEL_ACCESS_TOKEN)を使用したAPEXアプリケーションを作ってみます。

作成するAPEXアプリケーションに、以下の2つの操作を実装します。

  • LINE公式アカウントが受信したメッセージに返答する
  • LINE公式アカウントが受信した写真を保存する
LINE公式アカウントが受信したメッセージは、Webhookによって表LINE_MESSAGESに保存されます。この処理はすでに作成済みで、そのまま流用します。

作成したアプリケーションは以下のように動作します。LINE公式アカウントがメッセージを受信したことはAPEXアプリケーションでは検知しないため、手動でページをリロードしてレポートを再表示しています。

 

LINEアプリケーションの画面です。メッセージありがとうございます!とあるのは、LINE公式アカウントにデフォルトで設定されている応答メッセージです。


以下よりAPEXアプリケーションの作成手順を紹介します。

クイックSQLの以下のモデルから、受信した写真を保存する表LINE_IMAGESを作成します。
# prefix: line
images
    message_id vc20 /pk
    content blob
    content_type vc80
SQLワークショップのユーティリティのクイックSQLより、表の作成を行います。左ペインにモデルを記述し、SQLの生成、SQLスクリプトを保存、レビューおよび実行を順次クリックします。表LINE_IMAGESの作成までを実施し、APEXアプリケーションは作成しません。


LINE公式アカウントが受信したメッセージは、対話モード・レポートで表示します。以下のDDLを実行し、対話モード・レポートのソースとして使用するビューLINE_MESSAGES_Vを作成します。


1行のDDLなので、SQLコマンドに貼り付けて実行します。


アプリケーション作成ウィザードを起動し、空のアプリケーションを作成します。

名前はLINE応答とします。それ以外は変更せず、アプリケーションの作成をクリックします。


アプリケーションが作成されたら、ページの作成を実行します。


 作成するページのタイプとして、対話モード・レポートを選択します。


ページ定義のページ番号は2とします。後ほど記述するコードにページ番号が含まれているため、ここでは必ず2を指定します。レポート・ページの名前はLINEメッセージ、ページ・モードは標準とします。

フォーム・ページを含めるをONにします。フォーム・ページ番号は3、フォーム・ページ名は受信メッセージ、フォーム・ページ・モードにモーダル・ダイアログを選択します。受信したメッセージへの返信と受信した写真の保存は、フォームのページに実装します。

データ・ソースの表/ビューの名前として、先ほど作成したビューLINE_MESSAGES_Vを選択します。

ナビゲーションのブレッドクラムの使用、ナビゲーションの使用ともにデフォルトのONを選択します。

次へ進みます。


主キーの主キー列1としてMESSAGE_ID(Varchar2)を選択します。

以上で、ページの作成をクリックします。


対話モード・レポートとフォームのページが作成されます。

作成された対話モード・レポートの列CONTENTを選択し、タイプをBLOBのダウンロードに変更します。LINE公式アカウントが受信した写真を列CONTENTからダウンロードできるようにします。

BLOB属性の表名にLINE_IMAGES、BLOB列にCONTENT、主キー列1にMESSAGE_ID、MIMEタイプ列にCONTENT_TYPEを選択します。


ファイル名列を指定すると、写真をダウンロードする際にファイル名が付きます。LINE公式アカウントが受信した写真には名前が付いていないため、ファイル名列は指定していません。

ここで一覧されるメッセージはLINE公式アカウントが受信し、Webhookの処理で表に書き込まれます。フォームからメッセージを投入することは無いため、ボタンCREATEを削除します。


以上で、受信したメッセージを一覧する対話モード・レポートはできました。

続いてページ番号3のフォームのページを変更します。

非表示になっている主キーのページ・アイテムP3_MESSAGE_IDを除いて、すべてのページ・アイテムを表示のみに変更します。


少しフォームを見やすくするため、ページ・アイテムP3_IS_VALID、P3_RECEIVED_DATE、P3_SOURCE_TYPE、P3_CONTENT、P3_CONTENT_TYPEを選択し、レイアウトの新規行の開始をOFFに変更します。


返信する文字列を保持するページ・アイテムP3_REPLY_TEXTを作成します。

識別の名前はP3_REPLY_TEXT、タイプとしてテキスト領域を選択します。ラベルはReply Textとします。

返信するときだけページ・アイテムが表示されるように、サーバー側の条件としてタイプにアイテム = 値を選択し、アイテムにP3_MESSAGE_TYPE、値にtextを指定します。


このフォームに実装する処理は返信と写真の保存です。その処理に合わせてボタンを変更します。

最初にボタンDELETEを削除します。


ボタンSAVEはラベルを保存に変更します。動作のデータベース・アクションは- 選択 -に変更し、データベース・アクションとして未指定の状態にします。

サーバー側の条件のタイプとしてアイテム = 値を選択します。アイテムにP3_CONTENT_PROVIDER_TYPEを選択し、値にlineを指定します。


ボタンCREATEはボタン名をREPLYに変更し、ラベルは返信とします。動作のデータベース・アクションは- 選択 -に変更します。

サーバー側の条件のタイプにアイテム = 値を選択します。アイテムとしてP3_MESSAGE_TYPEを選択し、値にtextを指定します。


左ペインでプロセス・ビューを開きます。これよりLINE Messaging APIを発行し、返信と写真の保存を行うプロセスを実装します。

ウィザードにより作成されたプロセスプロセス・フォーム受信メッセージを削除します。


プロセスを作成しダイアログを閉じるの上に配置します。

LINE Messaging APIのReply APIについては、以下を参照しています。応答メッセージは応答トークン(replyToken)を使って送信しています。ドキュメントによると応答トークンは1分以内で使用する必要がある、とのことなので実際にはボットなどによる自動返信に用いるもので、今回のサンプルのように人による返信の場合は、応答メッセージ以外を使用することになるでしょう。
https://developers.line.biz/ja/reference/messaging-api/#send-reply-message

Messaging APIのReply APIはメッセージとしてカウントされませんが、Push APIはカウントされます。
https://www.linebiz.com/jp/service/line-official-account/plan/

識別の名前はReplyとします。タイプとしてコードの実行を選択し、ソースのPL/SQLコードとして以下を記述します。


サーバー側の条件のボタン押下時にREPLYを指定します。


同様の手順にてプロセスSaveを作成します。ソースのPL/SQLコードとして以下を記述します。LINE Messaging APIのドキュメントの以下を参照しています。
https://developers.line.biz/ja/docs/messaging-api/receiving-messages/#getting-content-sent-by-users


サーバー側の条件のボタン押下時にSAVEを指定します。


プロセスダイアログを閉じるを選択し、サーバー側の条件の値をSAVE,REPLYに変更します。


以上でアプリケーションは完成です。アプリケーションを実行すると、記事の先頭のGIF動画のように動作します。

今回作成したAPEXアプリケーションのエクスポートを以下に置きました。
https://github.com/ujnak/apexapps/blob/master/exports/line-messaging-api-sample.zip

Oracle APEXのアプリケーション作成の参考になれば幸いです。

完

2023年2月23日木曜日

LINE Messaging APIを使用する

Oracle APEXのアプリケーションよりLINEのMessaging APIを呼び出し、LINE公式アカウントよりメッセージの送受信を行うために必要な準備を行います。

概ね、チャネルアクセストークンを取得するための作業になります。

LINE Developesコンソールよりプロバイダーが作成済みであることを前提とします。以前の記事LINEアカウントによる認証などを参考にしてください。

LINE Messaging APIを使用するために、チャネルタイプがMessaging APIであるチャネルを新規に作成します。チャネルの作成方法はLINEから提供されているドキュメントを参照するか、過去記事のチャネルタイプがLINEログインの手順とほぼ同じですので、そちらを参照してください。

新規チャネル作成でMessaging APIを選択します。



チャネルを新規作成すると、チャネル名と同名のLINE公式アカウントが作成されます。作成当初はフリーの月額プランが選択されるようです。フリーのプランでは1000通まで無料でメッセージが送信できるとのことです。

LINE Official Account ManagerよりLINE公式アカウントの状況について確認できます。お金にかかわることもありますが、LINE公式アカウント自体の設定が多数あるため、事前にLINE公式アカウントについて理解しておく方が良いようです。Messaging APIはLINE公式アカウントで使える機能のうちの、ごく一部です。

これからMessaging APIを使う設定について説明します。

作成したMessaging APIのチャネル基本設定にチャネルシークレット、アサーション署名キー、あなたのユーザーIDが表示されています。

チャネルシークレットはLINE公式アカウントが受信したメッセージの署名の検証に使用します。アサーション署名キー(のID)はメッセージを送信するAPIの認証のために使用します。あたなのユーザーIDは、メッセージの送信をテストする際の宛先として使用します。

この他にチャネルIDも、Messaging APIの呼び出し時に使用します。



これからの作業でJSON Web Key、JSON Web Tokenやチャネルアクセストークンを生成します。それらの処理を実装したPL/SQLのパッケージUTIL_LINE_APIを作成します。LINEのドキュメントには色々なコンピュータ言語でのサンプルが掲載されていますが、PL/SQLのサンプルはありません。

パッケージのコードは以下になります。DBMS_CRYPTOのRSA署名の機能を使用しているため、Oracle Databaseは19c以上であることが前提です。

Oracle APEXでは、SQLワークショップのSQLスクリプトを使って実行できます。

アサーション署名キーを作成します。

PL/SQLよりDBMS_CRYPTO.SIGNを呼び出す際、秘密鍵はPKCS#1またはPKCS#8の形式で受け付けます。そのため、opensslを使って鍵ペアを生成し、その鍵ペアよりLINEのアサーション署名キーとして登録できるJSON Web Keyを作ります。

ビット長2048で鍵ペアを生成し、private.pemとして保存します。

openssl genrsa -out private.pem 2048

% openssl genrsa -out private.pem 2048

Generating RSA private key, 2048 bit long modulus

...................................................................+++++

.....+++++

e is 65537 (0x10001)

% 


最初にeの値を取り出します。通常は65537です。

openssl rsa -in private.pem -text -noout | grep publicExponent

% openssl rsa -in private.pem -text -noout | grep publicExponent

publicExponent: 65537 (0x10001)

% 


次にmodulusの値を取り出します。

openssl rsa -in private.pem -modulus -noout

Modulus=以降の値が暗号指数です。

% openssl rsa -in private.pem -modulus -noout

Modulus=BBABF46FC55DF62DCDAC79C00A978BF5B06041CEA20A19FD1CA95B0522ACE8CAD1CE81AC7F970307BD3191B20E8EB9DC356242A8304C6F2580E5C53EEACB53763033F436B7E7A1982435E6BBDC7927EC8E59F2EF5EA8FFCD76A2F66D290C68DFDEDDFE6CF1A8859700FCA25235C1662EC26C94A68379736F3C1F1492871D17D5A1507FC050AB83769FAF39D0E406DDCA695947142B010F5FF8AC99CFBA734FE63C965EA54C8A5CB61C60D34C35769F10C1443B3912830A0C112F03A9CAADC49956820B2E0A54095E5E6E5D6F769698FA8778C6264C8DE6C14704CA9BF0DC7B0BE63940497080618BFEEFC7854DCB6FF0262A968B2B7F6460244F9AFAE0295951

%


SQLコマンドよりUTIL_LINE_API.GENERATE_JSON_WEB_KEYを実行します。
begin
    dbms_output.put_line(
        util_line_api.generate_json_web_key(
            p_e => 65537
            ,p_n => 'Modulus=以降の値'
        )
    );
end;
結果にJSON Web Keyが表示されます。これをLINEのMessaging APIのチャネルのアサーション署名キーの公開鍵として登録します。


続いて、LINE公式アカウントがメッセージを受信したときに呼び出されるWebhookを設定します。

LINEからは、Oracle REST Data ServicesのRESTサービスをWebhookとして呼び出すようにします。

Webhookでは、受信したメッセージの署名の検証と、表LINE_MESSAGESに受信したメッセージを保存を行います。

表LINE_MESSAGESは、以下のクイックSQLのモデルより作成します。受信するメッセージはJSON形式ですが、BLOBで保存します。
# prefix: line
messages
    signature vc4000
    content blob
    is_valid vc1 /nn /default Y
    received_date date /default sysdate
SQLワークショップのユーティリティのクリックSQLより、表の作成を行います。


RESTサービスのハンドラに記述するコードを減らすため、ファンクションLINE_CALLBACKを作成します。署名の検証には、Messaging APIのチャネルシークレットが必要です。


RESTサービスを作成します。

SQLワークショップのRESTfulサービスを開きます。


最初にモジュールを作成します。左ペインのモジュールを選択し、モジュールの作成を実行します。


モジュール名はLINE、ベース・パスは/line/としました。公開はONにします。

モジュールの作成をクリックします。


モジュールLINEが作成されます。

続けてテンプレートの作成をクリックします。


Autonomous Databaseを使用している場合の注意点があります。完全なURLのパスがワークスペース名でなく、wksp_で始まるワークスペース・スキーマ名になっている場合があります。

その場合は、RESTfulデータ・サービスの画面の構成を開き、スキーマ別名をワークスペース名(wksp_を除く)に変更します。


テンプレートの作成では、URLテンプレートとしてcallbackを指定します。

テンプレートの作成をクリックします。


テンプレートcallbackが作成されます。

続けてハンドラの作成をクリックします。


ORDSハンドラ定義のメソッドとしてPOSTを選びます。ソースに以下のコードを記述します。


以上を設定して、ハンドラの作成をクリックします。


以上でWebhookの処理を行うRESTサービスが作成できました。

完全なURLをコピーし、LINEのチャネルのMessaging API設定のWebhook設定のWebhook URLに設定します。

検証をクリックし、Webhookの動作確認を行います。QRコードをLINEで読み込み、公式アカウントを友達として登録することで、LINEからメッセージを送信することもできます。


検証をクリックしてOKと表示されたら、Webhookの呼び出しが成功しています。

SQLコマンドより送信されたメッセージを確認します。

select id, signature, json_serialize(content), is_valid, received_date from line_messages;

IS_VALIDの値がYであれば、署名の検証も成功しています。


メッセージの受信はできたので、今度はメッセージの送信の方の設定を行います。

メッセージの送信の認証に使用するWeb資格証明を作成します。AuthenticationヘッダーをWeb資格証明として使用します。

ワークスペース・ユーティリティのWeb資格証明を開き、作成をクリックします。

Web資格証明の名前はLINE Channel Access Tokenとします。静的識別子としてLINE_CHANNEL_ACCESS_TOKENを指定します。認証タイプとしてHTTPヘッダーを選択します。

資格証明名はヘッダー名であるAuthorization、資格証明シークレットは適当な文字列を入力します。資格証明名と資格証明シークレットは、LINEのトークンURLを呼び出して取得したチャネルアクセストークンにより、置き換えられます。

以上で作成をクリックします。


メッセージの送信を行う準備ができました。

SQLコマンドより以下のコードを実行し、LINEのチャネルアクセストークンを取得します。取得したトークンはWeb資格証明のLINE_CHANNEL_ACCESS_TOKENに保存します。

キーIDが表示されれば、チャネルアクセストークンの取得は成功です。


 メッセージの送信をテストします。以下のコードを実行します。

あなたのユーザーIDの部分は、チャネル基本設定のあなたのユーザーIDとして記載されているIDに置き換えます。開発者自身にLINE公式アカウントよりメッセージが届きます。




LINEでメッセージが受信できれば、メッセージの送信についても確認が完了しました。

以上になります。

LINE公式アカウントでの基本的なメッセージの送受信ができるようになりました。

完

2023年2月21日火曜日

LINEアカウントによる認証

本記事ではLINE Developersコンソールよりプロバイダーとチャネルを作成し、APEXアプリケーションの認証スキームとしてLINEを使用できるようにします。

LINE Developersコンソールを開きます。URLはhttps://developers.line.biz/console/です。ログインをしていない場合は、ログイン画面が表示されます。私はビジネスアカウントを持っていないので、LINEアカウントでログインしました。

LINE Developersコンソールが開いたら、最初にプロバイダーを作成します。


プロバイダー名は任意です。個人の開発者、企業、組織を名前とします。今回はYuji N, Oracle APEX Developerとしました。本記事は実装例なので個人名、企業名、組織名ではありませんが、ユーザーが確認する同意画面に表示される情報なので、適切な名前を選ぶことをお勧めします。

作成を実行します。


プロバイダーYuji N, Oracle APEX Developerが作成されました。

LINEログインのチャネルの作成から始めます。


新規チャネル作成画面が開きます。

チャネルの種類、プロバイダーは設定済みです。サービスを提供する地域は(この記事の読者は日本人でしょうから)日本でしょう。会社・事業者の所在国・地域も日本でしょう。


チャネルアイコンの設定は任意です。チャネル名とチャネル説明は必須なので、それぞれ入力します。アプリタイプとしてウェブアプリを選択します。


メールアドレスを指定します。開発者のメールアドレスがデフォルトで設定されていると思います。

プライバシーポリシーURL、サービス利用規約URLは現時点では入力をスキップします。アプリケーションを作成し本番利用することがあれば、それまでには準備が必要でしょう。

LINE開発者契約の内容に同意しますにチェックを入れ、作成をクリックします。


チャネルが作成されます。

チャネル基本設定のチャネルIDは、APEXのWeb資格証明を作成する際に、クライアントIDまたはユーザーIDとして設定します。コピーを取得して保存しておきます。


下にスクロールします。

チャネルシークレットはAPEXのWeb資格証明のクライアント・シークレットまたはパスワードとして設定します。コピーを取得して保存しておきます。


さらに下にスクロールすると、Open ID Connectの設定項目としてメールアドレス取得権限があります。今回はメールアドレスを使わない設定を行います。そのため、ここは未申請のまま変更しません。



APEXの置換文字列APP_USERにメールアドレスを使いたい場合は、申請が必要です。申請をクリックして、いくつかの必要な情報を更新します。


一度申請をすると変更できないようです。その場合は、チャネルを作り直す必要があります。

LINEログイン設定のタブを開き、コールバックURLを設定します。編集をクリックします。

コールバックURLとしてhttps://APEXが動作しているホスト名/ords/apex_authentication.callbackを設定します。apex_authentication.callbackより前の部分は、APEXのURLのベースパスです。

Autonomous Databaseの場合、以下のような形式です。

https://ユニークなID-インスタンス名.adb.リージョン.oraclecloudapps.com/ords/apex_authentication.callback

コールバックURLを設定して、更新をクリックします。


LINE側の設定は一旦完了として、Oracle APEX側の設定に移ります。

ワークスペース・ユーティリティのWeb資格証明を開きます。


作成済みのWeb資格証明の一覧より作成をクリックし、作成フォームを表示します。

名前はLINE Account、静的識別子はLINE_ACCOUNT、認証タイプとしてOAuth2クライアント資格証明フローを選択します。

クライアントIDまたはユーザーIDとして、LINEのチャネル基本設定のチャネルID、クライアント・シークレットまたはパスワードとして、LINEのチャネル基本設定のチャネルシークレットを指定します。

以上で作成をクリックします。


Web資格証明に続いて、APEXアプリケーションを作成します。

アプリケーション作成ウィザードを起動します。名前はAPEX Demo Appとします。

アプリケーションの作成をクリックします。


アプリケーションが作成されたら、共有コンポーネントの認証スキームを開きます。


作成をクリックします。


スキームの作成はギャラリからの事前構成済スキームに基づくです。

次へ進みます。


作成する認証スキームの名前はLINE Accountとします。スキーム・タイプとしてソーシャル・サインインを選択します。

設定の資格証明ストアとして、先ほど作成したWeb資格証明LINE Accountを選択します。認証プロバイダとしてOpenID Connectプロバイダを選択します。

LINEのOpen ID Connectの検出URLは以下になります。

https://access.line.me/.well-known/openid-configuration

有効範囲(scope)としてprofileを指定します。openidはAPEXがデフォルトで有効範囲に含めます。またemailについてはLINE側で許可を与えていないため、有効範囲には含めません。

ユーザー名は#sub# (#APEX_AUTH_NAME#)とし、ユーザー名の大文字への変換はいいえとします。

以上で認証スキームの作成をクリックします。


認証スキームLINE Accountが作成され、カレントの認証スキームに設定されます。


認証スキームが作成されたので、アプリケーションを実行します。

LINEのログイン画面が表示されます。


ログインをクリックすると、初回ログイン時はプロフィール情報およびユーザー識別子のアプリへの使用を許可するかどうか、確認を求められます。


許可するをクリックすると、APEXアプリケーションが開きます。


以上でLINEアカウントによるAPEXアプリケーションの認証ができました。

認証スキームのユーザー名に設定した値#sub# (#APEX_AUTH_NAME#)が置換文字列APP_USERの値になります。APP_USERの値は一意であることが求められるため、属性subとAPEX_AUTH_NAMEの組み合わせ(Open ID Connectによる認証は、複数のプロバイダを切り替えられるように実装することが多い)が使用されています。

そのような理由はあるのですが、画面上の表示には不向きです。そのため、画面上にはLINEからの応答に含まれる属性nameを表示するようにAPEXアプリケーションを変更します。

属性nameの値をAPEXアプリケーションに保持するために、アプリケーション・アイテムを作成します。

共有コンポーネントのアプリケーション・アイテムを開きます。


作成をクリックします。


名前はG_DISPLAY_NAMEとします。有効範囲はアプリケーション、セキュリティのセッション・ステート保護は一番厳しいデフォルトの制限付き - ブラウザから設定不可を選択します。

アプリケーション・アイテムの作成をクリックします。


アプリケーション・アイテムG_DISPLAY_NAMEが作成されます。


ユーザー名が表示されているナビゲーション・バーの設定を変更します。

共有コンポーネントのナビゲーション・バー・リストを開きます。


ナビゲーション・バーを開きます。


名前が&APP_USER.となっているエントリの鉛筆アイコンをクリックし、そのエントリの編集画面を開きます。


エントリのセクションにあるリスト・エントリ・ラベルを&APP_USER.から&G_DISPLAY_NAME.に変更します。


ユーザー定義属性のセクションの2. List Item CSS Classesに設定されているhas-usernameの指定を削除します。この指定があると、ユーザー名が小文字に変換されて表示されるためです。

以上の変更を行い、変更の適用をクリックします。


ナビゲーション・バーの変更の適用を行います。


認証スキームに認証後のプロシージャを記述し、LINEの応答に含まれる属性nameをアプリケーション・アイテムG_DISPLAY_NAMEに設定します。

認証スキームLINE Accountを開き、設定の追加ユーザー属性としてnameを指定します。


ソースのPL/SQLコードに以下を記述します。



ログイン・プロセスの認証後のプロシージャ名としてpost_authを指定します。

以上で変更の適用をクリックします。


認証後のプロシージャを実行するには、アプリケーションのログインをやり直す必要があります。

APEXアプリケーションをログアウトし再度ログインすると、ナビゲーション・バーにLINEのログイン画面に表示されていた名前が表示されます。


以上で今回の作業は完了です。

実装したのは認証スキームだけですが、今回作成したAPEXアプリケーションのエクスポートを以下に置きました。
https://github.com/ujnak/apexapps/blob/master/exports/apex-demo-app-line.zip

Oracle APEXのアプリケーション作成の参考になれば幸いです。

完