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