ver.1.13.2



スパイラルAPIに「PDF帳票取得(pdf_report/get_file)」のメソッドを追加し、レコード別に差し替わったPDFを取得できるようにいたします。

■APIの仕様

クラス メソッド名 入出力 パラメータ 必須 説明 データ型
pdf_report get_file request spiral_api_token APIトークン 半角英数字
passkey epoch秒。APIトークンシークレットとpasskeyで署名を作成する。署名の有効期限チェックにも使用する。有効期限は作成してから30分。 int
signature 署名 半角英数字
pdf_report_title PDF帳票名 半角英数字, アンスコ, ハイフン 16文字以内
key_field_title 取得対象を特定するためのフィールド。
一意制約のフィールドのみ指定可能。(IDも可)
半角英数字, アンスコ, ハイフン 16文字以内
key_field_value 取得対象を特定するための値(null、空値の入力は許容しない) フィールドタイプに依存
response code 応答コード int
message 応答メッセージ 半角英数字記号
file_name テンプレートファイル名 半角英数字記号(カンマ、ドット、ハイフン、アンダースコア)
data 取得したファイルのbase64エンコードしたデータ。ファイルが存在しない場合、nullとなる。 半角英数字
■使用例
人事担当者が社員毎に差し替わる労働条件通知書のファイルを取得したい。

before
マイエリアにログインした場合のみ、差し替わったPDFを取得することができません。
全員分のファイルを取得するためには、都度社員毎のIDでログインする必要があり、手間がかかり現実ではない。
after
APIで指定したレコードのファイルが取得できるようになり、都度マイエリアにログインする必要がなくなる。

※ 詳細画面で表示される操作画面は開発中のものを掲載しており、変更する可能性がございます。