2023年2月28日火曜日

PayPay Open Payment APIの呼び出しに必要なHMACオブジェクトを生成する

 PayPayのOpen Payment APIのSDKとして提供されているのは、Python、Node、Java、PHPのみでPL/SQLは含まれていません。また、ドキュメントのサンプル・コードも同様です。

Oracle APEXにPayPayのWeb決済を組み込むには、API認証をできるようにする必要があります。PayPayが提供しているAPI認証の説明を読んで、HMACオブジェクトを生成するPL/SQLパッケージを作ってみました。

API認証のドキュメントにある認証オブジェクトに必要なパラメータに記載されているExampleの値を引数として、作成したプロシージャgenerate_hmac_authを呼び出してみます。


結果として以下が印刷されました。

1j0FnY4flNp5CtIKa7x9MQ==
NW1jKIMnzR7tEhMWtcJcaef+nFVBt7jjAGcVuxHhchc=
APIKeyGenerated:NW1jKIMnzR7tEhMWtcJcaef+nFVBt7jjAGcVuxHhchc=:acd028:1579843452:1j0FnY4flNp5CtIKa7x9MQ==

実装を検証するために、PayPayのAPI認証のドキュメントに記載されているJavaのサンプルを、同じ引数を与えて実行してみます。


% javac PayPayAuth.java

% java PayPayAuth 

1j0FnY4flNp5CtIKa7x9MQ==

NW1jKIMnzR7tEhMWtcJcaef+nFVBt7jjAGcVuxHhchc=

% 


以下の結果が得られます。

1j0FnY4flNp5CtIKa7x9MQ==
NW1jKIMnzR7tEhMWtcJcaef+nFVBt7jjAGcVuxHhchc=

Base64でエンコーディングされたHMACオブジェクトの結果が同じなので、PL/SQLのコードも概ね正しい実装になっていそうです。

API認証に使用するHMACオブジェクトを生成できたので、APEXからPayPay Open Payment APIを呼び出せるでしょう。

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を指定します。レポート・ページの名前LINEメッセージページ・モード標準とします。

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

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

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

へ進みます。


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

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


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

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

BLOB属性表名LINE_IMAGESBLOB列CONTENT主キー列1MESSAGE_IDMIMEタイプ列CONTENT_TYPEを選択します。


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

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


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

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

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


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


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

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

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


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

最初にボタン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月27日月曜日

OCI Languageサービスを使用して翻訳を行う

 オラクルのOCI Languageに無料枠があったので、APEXでOCI Languageの翻訳サービスを呼び出すアプリケーションを作ってみました。


OCIでのAPIユーザーの作成手順およびAPEXでのWeb資格証明の作成手順については、以前に書いた記事を参考にしています。

APEXからOCIオブジェクト・ストレージを操作する(1) - APIユーザーの作成
APEXからOCIオブジェクト・ストレージを操作する(4) - Web資格証明の作成

上記の手順に追加して、APIキーを持つユーザーにOCI Languageサービスの呼び出しを許可するため、ポリシーを作成します。

APIユーザーが含まれているグループAPEXObjectManagersである場合、ポリシー・ステートメントは以下になります。

allow group APEXObjectManagers to use ai-service-language-family in tenancy


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

作成したアプリケーションのホーム・ページページ・デザイナで開き、ページ・アイテムボタンを作成します。

翻訳する文字列の言語を指定するページ・アイテムP1_SOURCE_LANGを作成します。タイプテキスト・フィールドラベルSource Langとします。ISO 639-1のコードを指定します。タイプ選択リストにすると、指定が容易になるでしょう。


翻訳する文字列を指定するページ・アイテムP1_SOURCE_TEXTを作成します。タイプテキスト領域ラベルSource Textとします。


同様に翻訳先の言語を指定するページ・アイテムP1_TARGET_LANGを作成します。


翻訳結果を保持するページ・アイテムP1_TARGET_TEXTを作成します。


最後に送信ボタンを作成します。

識別ボタン名SUBMITラベルSubmit動作アクションはデフォルトのページの送信のままとします。


左ペインでプロセス・ビューを開き、ボタンSUBMITを押した時に実行するプロセスTranslateを作成します。

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


サーバー側の条件ボタン押下時SUBMITを選択します。


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

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

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

レンダリング・ツリーにチェックボックスが表示されたときの対処

 ページ・デザイナの右ペインに表示されるレンダリング・ツリーに、チェックボックスが現れる場合があります。以下のような状態です。

タッチ操作が有効なデバイスの場合上記の表示になりますが、タッチ操作が有効でないデバイスでも上記のように表示される場合があります。

原因と対処について、Scott WesleyさんがForumsに投稿されていました。

https://forums.oracle.com/ords/apexds/post/checkboxes-appearing-next-to-components-in-page-builder-5413

TwitterでMagaly Irahetaさんが、ブラウザのセッション・ストレージにあるORA_WWV_apex.core.userHasTouchedというキーを削除すると直ると教えてくれています。



セッション記憶域に保存されるAPEX.userHasTouchedについては、APEXのリリース・ノートのプライバシに関する通知に記載があります。

フォーラムに書かれている原因と、Twitterでの対処方法について確認してみます。

ページ・デザイナを開いてチェックボックスが表示されている状態で、ブラウザの開発者ツールを開きます。アプリケーション・タブを選択し、セッション・ストレージの内容を確認します。

キーORA_WWV_apex.core.userHasTouchedに値yが設定されていることが確認できます。


このキーを削除してページ・デザイナをリロードすると、チェックボックスは表示されなくなります。


キーORA_WWV_apex.core.userHasTouchedが作成されるタイミングですが、開発者ツールにてデバイス・エミュレーションを有効にし、どこでも良いので画面上でポインタをクリックすると、キーが作成されます。


キーを削除しても上記の操作を行うと、再度ORA_WWV_apex.core.userHasTouchedが作成されてチェックボックスが表示されます。

開発者ツールでの操作以外に、JavaScriptコンソールより以下を実行し、キーORA_WWV_apex.core.userHasTouchedを削除する、または、nを設定することができます。

window.sessionStorage.removeItem("ORA_WWV_apex.core.userHasTouched");

または

window.sessionStorage.setItem("ORA_WWV_apex.core.userHasTouched","n");

タッチ操作ができないデバイスで、チェックボックスが表示されるケースでは上記で対応できるはずです。ページ・デザイナでデバイス・エミュレーションを行う必要はないためです。

タッチ操作が有効なデバイスの場合は、ページ・デザイナの画面に触った時点でタッチ操作が有効と認識されて、それ以降はタッチスクリーン対応の表示に切り替わるようです。

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公式アカウントでの基本的なメッセージの送受信ができるようになりました。