Web API導入について
※この記事はLinkPrint CLOUD Web APIの利用を検討しているお客様向けの内容となります。
LinkPrint CLOUD Web APIとは
LinkPrint CLOUDでは帳票資産の一元化が行えることを強みとしており、Web APIを利用することで連携元の業務システムで管理・作成した印刷データを、LinkPrint CLOUDで作成した独自デザインの帳票へ簡単に出力できます。
「現在のシステムから印刷データは作成できるが、印刷は他社のサービスを利用して行っている」「少量の印刷に対応したい」「事業所ごとに異なる帳票フォーマットを統一して管理したい」といったお客様のニーズに合わせて、柔軟に対応することが可能です。
エンドユーザ企業側での帳票デザイン作成や修正にも対応しており、手離れの良いシステム構築が行えます。
＜送付機能API＞
2025年7月に「送付機能API」を公開しました。APIを利用し、送付管理機能の送付物作成が可能となりました。
※CSV等の印刷データを使用し差し込み印刷で送付物を作成する機能に限定
＜送り状発行API＞
2025年8月に「送り状発行API」を公開しました。APIを利用し、利用登録済みの運送会社における送り状の発行が可能となりました。
※ご利用の際には、各運送会社との契約が必要です。
LinkPrint CLOUD Web APIの種類
【帳票印刷API】
これまでブラウザから利用可能な「JS版」を提供してきましたが、新たにサーバサイドで利用可能な「SS版」を2025年2月に公開しました。用途に応じて、最適なAPIをご活用ください。
＜JS版＞
JS版は、ブラウザから直接アクセスできるWeb APIです。対象のフォームに対して差し込み印刷した後、編集画面を開き差し込み印刷後に調整をする方法やPDFファイルをそのままダウンロードする方法、PDFファイルをダウンロードするURLを返す方法など、差し込み印刷後の動きの指定が可能です。ブラウザ上での動作に特化しています。
※「開発版」アカウントと「ユーザ版」アカウントが連携している必要があります。
＜SS版＞
SS版はRPC APIでの提供スタイルです。バッチ処理やバックエンドシステムからも利用でき、帳票への差し込み印刷＆PDFファイルの作成が可能です。差し込み印刷の結果はPDFファイルのダウンロードURLの取得となります。
詳細については、以下の「SS版のご利用について」の部分をご確認ください。各ヘルプへのリンクもございます。
※「SS版」は「ユーザ版」アカウントのみでご利用いただけます。
【送付機能API】
「帳票印刷API」の「SS版」と同様の提供スタイルです。アクセス元はブラウザに限定されずバッチ処理やバックエンドシステムからも利用できます。連携元システムから送付物の作成を行えます。「送付機能API」は「ユーザ版」アカウントのみの利用でご利用いただけます。（「開発版」アカウントと連携している場合もご利用いただけます）
【送り状発行API】
「帳票印刷API」の「SS版」と同様の提供スタイルです。アクセス元はブラウザに限定されずバックエンドシステムからも利用できます。連携元システムから送り状の発行を行えます。「送り状発行API」は「ユーザ版」アカウントのみの利用でご利用いただけます。（「開発版」アカウントと連携している場合もご利用いただけます）
※「帳票印刷API」、「送付機能API」、「送り状発行API」は別々のお申し込みが必要です。
LinkPrint CLOUD Web API ご利用の流れ
STEP1
【お客様】LinkPrint CLOUDおよびLinkPrint CLOUD Web API用アカウントのお申し込み
※導入に際してのお問い合わせ・お申し込みはお問い合わせフォームより承ります。
STEP2
【弊社】お申し込み内容ヒアリングのうえ、利用設定・ご案内
STEP3
【お客様】LinkPrint CLOUD Web APIを利用してシステム開発
STEP4
【お客様】
（※帳票印刷API（JS版）の場合）印刷用のテンプレートフォームの作成・共通化
印刷データを連携し、帳票印刷や送付物作成を行う
用語
| 開発会社 | 「開発版」アカウントを利用される企業様 |
| LinkPrint CLOUD 開発版アカウント |
Web APIをご利用いただくために開発会社様にご契約いただくLinkPrint CLOUDアカウント名 （お申し込み後、弊社で開発会社様宛にご用意いたします） |
| 利用会社 | Web APIを導入する連携元システムを利用されている企業様（エンドユーザ） |
| LinkPrint CLOUD ユーザ版アカウント |
Web APIをご利用いただくために利用会社様にご契約いただくLinkPrint CLOUDアカウント名 |
| 共通テンプレートフォーム | 開発会社様がLinkPrint CLOUD 開発版アカウントで作成し、各利用会社様のユーザ版アカウントへ共通化を行ったテンプレートフォーム |
| 共通フォームカテゴリ | 開発会社様がLinkPrint CLOUD 開発版アカウントで作成し、各利用会社様のユーザ版アカウントへ共通化を行ったフォームカテゴリ |
| 開発者ID |
Web APIをご利用いただくための開発会社様用のIDで、弊社が発行いたします ※「帳票印刷API」JS版のみ利用 |
| 連携利用ID | 「帳票印刷API」のWeb APIをご利用いただくための利用会社様用のIDで、開発者ID同様、弊社が発行いたします |
| 連携ファイルID | 「送り状発行API」で連携されるデータの各項目と各運送会社が用意している各項目とを対応付けします。その対応付けを識別するためのIDです。 例：O12341 |
| 利用判別キー | 「送り状発行API」で連携されるデータの中で運送会社を判別するための情報を指します。 |
| ファイル管理用ID | 「送り状発行API」でアップロードされたデータに付与される管理用ID。「送り状発行API③：ファイルアップロード＆確認」にアクセスし取得できます。 |
| データ管理用ID | 「送り状発行API」でアップロードするデータの各レコードに、ユーザが任意に付与する管理用IDで、1データ内で一意である必要があります。発行された送り状番号と紐づけるために使用します。 |
| 運送会社ID | 「送り状発行API」で指定する運送会社を識別するためのID |
| APIキー | 「帳票印刷API（SS版）」、「送付機能API」、「送り状発行API」をご利用いただく際に必要な情報です。弊社が発行いたします。 |
「帳票印刷API」JS版のご利用について
| 貴社システムへの組み込み | Web APIのご利用には、ご申告いただく利用元ドメインのWebサーバに認証用のテキストファイルを配置していただく必要があります。 また、Web APIの呼び出し関数をまとめたJavaScriptファイルもご用意しています。 詳細は左記の「帳票印刷API」の①②④のリンクよりご確認ください。 ※認証方法について、詳しくはこちらをご覧ください。 |
| LinkPrint CLOUD 開発版アカウントで作成した共通テンプレートフォーム、および当Web API呼び出し時に指定された利用会社様がユーザ版アカウントで作成したテンプレートフォーム情報を、json形式で返します。 このWeb APIで取得できるテンプレートフォームIDを、帳票印刷API④で利用します。 詳細は左記リンクよりご確認ください。 |
|
| 帳票印刷API（JS版）②： テンプレートフォームの詳細情報取得 |
帳票印刷API（JS版）①で取得した各テンプレートフォームの、テンプレートフォーム名・用紙サイズといった詳細情報を取得することができます。 詳細は左記リンクよりご確認ください。 |
| 帳票印刷API（JS版）③： 印刷データのアップロード |
帳票印刷API（JS版）④で差し込み印刷を行うための印刷データのアップロードを行い、ファイルIDをjson形式で返します。 アップロードされたファイルは暗号化されますので、安心してご利用いただけます。 詳細は左記リンクよりご確認ください。 |
| 帳票印刷API（JS版）④：帳票の差し込み印刷 | 印刷するテンプレートフォームIDと、帳票印刷API（JS版）③で取得したファイルIDを指定し、差し込み印刷を行います。 詳細は左記リンクよりご確認ください。 |
「帳票印刷API」SS版のご利用について
| 貴社システムへの組み込み | 各APIをご利用いただく際に「APIキー」が必要になります。「APIキー」の取得についてご確認ください。 ※認証方法について、詳しくはこちらをご覧ください。 |
| 帳票印刷API（SS版）①：ログイン | 「帳票印刷API（SS版）」の各APIで使用するアクセストークンの情報を取得します。 |
| 帳票印刷API（SS版）②：ログアウト | 取得したアクセストークンを無効化します。 |
| 帳票印刷API（SS版）③：テンプレートフォーム一覧の取得 | 利用可能なフォームの一覧を取得します。標準テンプレートフォーム、オリジナルテンプレートフォームが対象のフォームになります。 開発版と連携している場合は、開発版アカウントが共通化したテンプレートフォーム、開発版アカウントが共通化したフォームカテゴリを使用しユーザ版アカウントが作成したテンプレートフォーム、これらも対象になります。 |
| 帳票印刷API（SS版）④：テンプレートフォームの詳細情報取得 | 対象テンプレートフォームの詳細情報を取得します。 |
| 帳票印刷API（SS版）⑤：印刷データのアップロード | 差し込み印刷に使用する印刷データをアップロードします。成功すると「printDataId」という情報が取得でき、次の差し込み処理に使用します。 |
| 帳票印刷API（SS版）⑥：差し込み印刷受付 | 印刷データアップロードで取得した「printDataId」と対象のフォームIDを指定して差し込み印刷を行います。差し込み印刷処理を受け付けた後「受付ID」を返します。差し込み印刷の状況や作成したPDFファイルのURLを取得する際に「受付ID」を使用します。 |
| 帳票印刷API（SS版）⑦：差し込み印刷結果取得 | 「受付ID」を使用し、差し込み印刷の状況や作成したPDFファイルのURLを取得します。 |
| 帳票印刷API（SS版）⑧：PDFファイル取得 | ⑦差し込み印刷結果取得で取得できる「pdf_url」を使用し、PDFファイルをダウンロードします。 |
「送付機能API」のご利用について
| 送付機能API①：ログイン | 各APIで使用するアクセストークンの情報を取得するため、LinkPrint CLOUD ユーザ版のログイン情報を使用しログインをします。 |
| 送付機能API②：ログアウト | 「送付機能API①：ログイン」で取得した「access_token」を無効化する時に利用します。 |
| 送付機能API③：送付管理情報取得 | 取引先マスタに登録済みの各取引先毎に登録している送付管理情報を取得します。 |
| 送付機能API④：差し込み印刷で送付物作成の受付 | 送付物を作成するには、一旦このAPIを利用し作成の受付を行います。成功した場合は「受付ID」の取得ができ、「送付機能API⑤：送付物登録＆送付物ID取得」を使用し送付物の登録を行います。 |
| 送付機能API⑤：送付物登録＆送付物ID取得 | 「送付機能API④：差し込み印刷で送付物作成の受付」の受付IDを使⽤し、送付物の登録と登録後の送付物IDを取得します。 |
| 送付機能API⑥：登録済み送付物情報取得 | 登録済み送付物の情報（承認状態や送付の状態、作成者や取引先情報）を取得します。 |
| 送付機能API⑦：送付物PDF取得 | 登録した送付物のPDFを取得します。 |
「送り状発行API」のご利用について
| 送り状発行API①：ログイン | 各APIで使用するアクセストークンの情報を取得するため、LinkPrint CLOUD ユーザ版のログイン情報を使用しログインをします。 |
| 送り状発行API②：ログアウト | 「送り状発行API①：ログイン」で取得した「access_token」を無効化する時に利用します。 |
| 送り状発行API③：ファイルアップロード＆確認 | 送り状発行に使用するデータをアップロードし、データの整合性チェックおよび各運送会社APIとの連携チェックを行います。「ファイル管理用ID」を取得します。 |
| 送り状発行API④：送り状発行 | 「送り状発行API③：ファイルアップロード＆確認」で取得した「ファイル管理用ID」を使用し、送り状の発行依頼を行います。 |
| 送り状発行API⑤：送り状PDF取得 | 「送り状発行API③：ファイルアップロード＆確認」で取得した「ファイル管理用ID」を使用し、送り状のPDFファイルを取得します。 |
| 送り状発行API⑥：送り状番号取得 | 「送り状発行API③：ファイルアップロード＆確認」で取得した「ファイル管理用ID」を使用し、送り状番号を取得します。 |
| 送り状発行API⑦：送り状再発行（佐川急便用） | 有効期限が切れた佐川急便の送り状に対して、送り状の再発行依頼を実施します。 |
| 送り状発行API⑧：荷物受渡書・出荷明細書発行（佐川急便用） | 佐川急便用の荷物受渡書・出荷明細書のPDFを取得します。 |
| 送り状発行API⑨：ファイル管理用ID取得 | ユーザが「送り状発行API③：ファイルアップロード＆確認」で使用したデータ内で付与したデータ管理用IDを使用し、「ファイル管理用ID」を取得します。 |
| 送り状発行API⑩：連携ファイルIDの情報取得 | 登録済みの「連携ファイルID」毎に、利用判別キーとその値、また、対応付け情報を取得します。 |
| 運送会社IDについて |
上記APIの中で、以下のいずれかの運送会社IDを指定できます。 ※運送会社IDを指定しない場合は、利用登録済みのすべての運送会社が対象となります。 |
共通化とは
Web APIを導入した貴社システムから書き出す印刷データを使って、貴社システムを利用されているエンドユーザ様（以下、利用会社様）が差し込み印刷を行うためには、印刷データの各項目がどういった役割のオブジェクトなのかを決める「フォームカテゴリ」と、印刷する「テンプレートフォーム」の準備が必須となります。
貴社が作成した「フォームカテゴリ」と「テンプレートフォーム」は、数ある利用会社様のうち、貴社が使用許可を出した利用会社様のみ利用することができます。
各利用会社様に「フォームカテゴリ」または「テンプレートフォーム」の使用許可を出すことを「共通化」と呼び、共通化されたカテゴリを「共通フォームカテゴリ」、フォームを「共通テンプレートフォーム」と呼びます。
LinkPrint CLOUDアカウントについて
LinkPrint CLOUDのユーザ版アカウントにお申し込みいただく必要がございます。
LinkPrint CLOUDのユーザ版アカウントの詳細は、こちらよりお問い合わせください。
お申し込み・お問い合わせ
お申し込み・お問い合わせは、LinkPrint CLOUDお問い合わせフォームより承ります。