※LinkPrint CLOUD Web APIの概要や本記事内に記載されている用語についての説明はこちらをご確認ください。
差し込み印刷で送付物作成の受付
送付物を作成するには、一旦このAPIを利用し作成の受付を行います。成功した場合は「受付ID」の取得ができ、「送付機能API⑤：送付物登録＆送付物ID取得」を使用し送付物の登録を行います。
| URL |
https://www.lpcloud.jp/smf_api/reg_ins_item/ |
| POST情報 |
＜共通項目＞
| キー |
値 |
| *user_id |
ユーザ版アカウントのログインID |
| *access_token |
ログイン時に取得した「access_token」 |
| *api_key |
APIキー |
| *cust_code_col_num |
印刷データ内で「取引先コード」の値を保持している列の番号を指定してください。
※1列目は「0」となります。 例：10列目：9を指定ください。 |
| target_all |
印刷データ内のすべての取引先コードを対象にする場合は「1」を指定してください。
下に示す「reg_infos_each_cust」に指定した取引先コードのみを対象にする場合は「2」を指定してください。
未指定の場合は「1」となります。
「1」を選択された場合も、対象の取引先が、複数の送付方法が利用可能になっている（かつ、標準送付方法の指定がない）、設定されたテンプレートフォームが複数存在する、という場合は、送付方法、テンプレートフォームそれぞれに対して対象を指定していただく必要がありますので、下に示す「reg_infos_each_cust」に情報をご指定ください。 |
| form_divide_all |
作成するすべての送付物に対して、フォーム振り分けをする場合は「1」を指定してください。「0」を指定、もしくは何も指定しない場合はフォーム振り分けを実⾏しません。 |
| reg_infos_each_cust |
取引先ごとに利用するテンプレートフォーム、送付方法、フォーム振り分けを指定します。 |
| ⇒ （取引先コード） |
|
| ⇒⇒ form_id |
差し込み印刷に使⽤するテンプレートフォームのidを指定（1つのみ設定されている場合は指定不要です）。 |
| ⇒⇒ send_method |
送付方法のidを指定してください。利用可能な送付方法が1つのみの場合は指定不要です。
利⽤可能送付方法が複数あり、送付方法の指定が無い場合は、標準の送付方法を利⽤する動きになります。（標準の送付方法の設定がされている必要があります）
「印刷」：「1」、「電子送付」：「2」、「郵送」：「4」、「FAX送付」：「5」 |
| ⇒⇒ form_divide |
フォーム振り分けをする場合は「1」を指定してください。「0」を指定、もしくは何も指定しない場合はフォーム振り分けを実⾏しません。
このキーに対して値が指定されている場合は「form_divide_all」に値が指定されている場合でもこの値を優先します。 |
＜印刷データにCSVを利用する場合＞
| キー |
値 |
| *print_data |
CSVファイル
[ファイルタイプ]
●カンマ区切り、タブ区切りのテキストファイル
1回のアップロードでは1ファイルのみアップロード可 |
| *print_text_info |
以下の情報を指定
| delimiter |
区切り文字の指定
カンマ区切り：comma
タブ区切り：tab
「comma」もしくは「tab」をご指定ください。 |
| title_row_no |
項目名（各列のタイトル）の開始行の番号
（テキストファイルの場合は、「1」を指定する場合が多いと推測します）
※項目名が無い場合は「0」を指定してください。
|
| title_col_no |
項目名（各列のタイトル）の開始列の番号
（テキストファイルの場合は、「1」を指定する場合が多いと推測します） |
上記情報をjson文字列にし、POSTします。
例：{“delimiter”:”comma”,”title_row_no”:”1″,”title_col_no”:”1″}
|
＜印刷データにExcelファイルを利用する場合＞
| *print_data |
Excelファイル
1回のアップロードでは1ファイルのみアップロード可 |
| *print_excel_info |
以下の情報を指定
| sheetName |
シート名を指定ください。 |
| title_row_no |
項目名（各列のタイトル）の開始行の番号を指定してください。 |
| title_col_no |
項目名（各列のタイトル）の開始列の番号を指定してください。 |
上記情報をjson文字列にし、POSTします。
例：{“sheetName”:”Sheet1″,”title_row_no”:”1″,”title_col_no”:”1″}
|
＜印刷データにjsonデータを利用する場合＞
| キー |
値 |
| *print_data_json |
jsonデータ
以下のように「title」と「data」部分に分けて形成してください。
「title」は、CSVデータの1行目、項目名の行とご認識ください。
「data」は、CSVデータの2行目以降の情報とご認識ください。
{
"title":[
"住所","会社名","担当者名"
],
"data":[
["愛知県東区葵3ｰ14ｰ12","AA株式会社","山田太郎"],
["愛知県東区葵3ｰ14ｰ13","BB株式会社","山田次郎"]
]
}
|
|
| 戻り値 |
json⽂字列で返します。
| キー |
値 |
| receipt_id |
受付IDです。「送付機能API⑤：送付物登録＆送付物ID取得」で使用します。 |
| msg |
エラーが発生した際のエラーメッセージを返します。 |
| error_cust_code |
「msg」にエラーメッセージが指定された場合、そのエラーが発生した対象の取引先コードを返します。
・送付管理情報の登録がない取引先コード
・利⽤可能な送付方法がない取引先コード
・指定された送付方法が使⽤不可な取引先コード
・送付方法の指定が必要な取引先コード
・指定されたテンプレートフォームが使⽤不可な取引先コード
・テンプレートフォームの指定が必要な取引先コード |
| is_expired |
「access_token」の有効期限切れの際に「1」を返します。 |
|
「*」 このマークが付いている項目は必須項目です。
※＜フォーム振り分け＞
以下の種類のみ利⽤可能です。
・「１つの印刷データを複数のフォームに差し込み印刷する」 － ①指定順に連続したPDFを作成。 PDFファイルを1ファイルにまとめて作成。
・「2ページ目以降を別フォームに差し込みし1つのPDFを作成する」
※「is_expired」が「1」の場合は、システム内に保管されている「access_token」の有効期限が過ぎている状態になっています。システム内に保管されている「access_token」の値を空にし、再度ログインを実施してください。
