メインコンテンツへスキップ
サインイン Menu

faximoSilverを利用したFAX送信

  • 更新

faximoSilverのAPIを使用したFAX送信する方法です。
事前準備としてJSONデータを用意し、その後FAXを送信させます。

 

事前準備

PDFファイルをbase64Binaryに変換させた値を含むJSONファイルを作成するために、以下の手順を実行します。

 

PASE Shell上で実行

メインメニューで以下のコマンドを実行します。

call qp2term

 

ディレクトリの移動とPATHの追加

JSONファイルを生成するプログラムが置かれているディレクトリへ移動し、nodeコマンドを使用可能にするために、以下の2つのコマンドを実行します。

cd /home/callapi
PATH=/QOpenSys/pkgs/bin:$PATH

__________2022-06-21_14.17.20.png

 

変換プログラムの実行

パラメータを以下のフォーマットに沿って入力し、JSONファイルを作成します。
※下線が引かれている箇所の入力値を適切な値に入れ替えて実行してください。

node crtjson.js [FAX番号] [PDFファイル] 件名 出力先 userkey

  • FAX番号：送信先のFAX番号。送信先が複数ある場合はカンマ区切りで追加
  • PDFファイル：送信するPDFファイルが置かれているIFS、ファイルが複数ある場合はカンマ区切りで追加
  • 件名：FAX送信する時の件名
  • 出力先：生成されたJSONファイルの出力先のIFS
  • userkey：任意の文字列、送信履歴の検索時に検索条件として使用可能
node crtjson.js [03352773292] [/home/satou/test1.pdf,/home/satou/test2.pdf] 送信テスト /home/satou/faximo.json userkey01

__________2022-06-21_14.23.05.png

実行完了

成功すると、出力先に指定したIFSに以下のようなデータを持つJSONファイルが生成されます。attachmentdataの値にはbase64Binaryに変換されたPDFファイルが含まれます。

{
  "sendto":[
    {"faxno":"0300001111"}
  ],
  "userkey":"userkey01",
  "subject":"送信テスト",
  "Attachment":[
    {"attachmentname":"file0.pdf","attachmentdata":"xxxxxxxxxx..."},
    {"attachmentname":"file1.pdf","attachmentdata":"xxxxxxxxxx..."}
  ]
}

 

FAX送信（実行）

faximoSilverの送信依頼APIを実行する為の定義を作成します。
今回作成するAPIに不要な設定画面（BODY, COOKIE, QUERY, FILE(IFS), HEADER(IFS)）に関する説明は省略しています。

 

API-Bridge（Client）の初期画面

API-Bridge（Client）を起動すると登録済みの定義一覧が表示されるので、「F6」で新規追加を実行します。
callapi01.png

 

定義・HEADERS画面
__________2022-06-21_11.13.58.png

入力項目

  • 定義キー：定義のキーを入力します。必須項目で、既に登録済みのKEYと重複させることはできません。
  • 定義名：表示用の定義名を入力します。
  • API実行URL：faximoSilverの送信依頼（POST）のリクエストURLを入力します。
  • メソッド：メソッドを入力します。今回使用するAPIはPOSTなので、「*POST」と入力します。

パラメータ

  • HEADERS1
    • キー：Content-Type
    • 値：application/json
  • HEADERS2
    • キー：X-Processkey
    • 値：最大20桁の任意の文字列 (例. faximo-request)
  • HEADERS3
    • キー：X-Auth
    • 値：「ログインID:パスワード」をBase64エンコードしたもの(例. 「user01:password01」をBase64エンコードすると「dXNlcjAxOnBhc3N3b3JkMDE=」)

 

BODY（JSON）画面

__________2022-06-21_13.22.15.png

入力項目

  • BODY(JSON)：予め用意していたbase64Binary化されたpdfファイルを含むJSONファイルのIFSを入力します。
    例「/home/faximo/request01.json」
    {
      "sendto":[
        {"faxno": "0300001111"}
      ],
      "subject":"TESTSend",
      "userkey":"testsend001", 
      "Attachment":[
        {
          "attachmentname":"file0.pdf",
          "attachmentdata": "xxxxxxxxxxxxxxxxxxxxxx"
        }
      ]
    }

出力先

__________2022-06-21_13.34.17.png

入力項目

  • ライブラリ：APIから取得したJSONを基に作成されたファイルを保持するライブラリを入力します。
  • GENERAL：APIから取得したGENERALデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。
  • RESPONSE HEADERS：APIから取得したRESPONSE HEADERSデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。
  • REQUEST HEADERS：APIから取得したREQUEST HEADERSデータをファイルとして保存する場合は「*YES」を、しない場合は「*NO」を入力します。

保存

入力が完了したら「F5」で定義の実行と保存がされます。
実行結果のメッセージが表示され、定義ファイルの一覧に追加されます。
callapi10.png

関連記事