テンプレートを登録する

REPOTEN-API の WebAPI を使って PDF を生成するためには 「テンプレートを作る」 で作成したテンプレートファイルを 登録し簡単な設定を行う必要があります。このページではその手順と注意事項について説明します。

前提

このページの手順を行うには、以下の作業が完了している必要があります。

登録する

REPOTEN-API に サインイン します。

テンプレートの登録画面へ

「テンプレートの管理」ページの登録アイコンボタンをクリックします。サインイン後に表示されるページが「テンプレートの管理」でない場合は、右上のメニューから移動して下さい。

新しいテンプレート

「 Tlf ファイル」に用意した .tlf ファイルを指定し「名前」を入力して下さい。ここでは「テンプレートを作る」で作成した「○○イベント参加証テンプレート」を登録しています。以下、それぞれの項目について簡単に説明します。

名前
管理用のテンプレート名です。生成される PDF には影響しません。
説明
テンプレートの説明です。テンプレートに関するメモとしても使えます。
TLFファイル
専用デザイナで作成したテンプレートファイル( .tlf )を指定します。 tlf ファイルのみ指定できます。
PDF生成時のファイル名
生成される PDF のファイル名です。指定されていない場合は tlf ファイルのファイル名が使用されます。主に HTML フォームから利用する場合に有用でしょう。
PDF生成時のアクション
主に HTML フォームから利用する場合のオプションです。 「表示」の場合はブラウザに表示され、「保存」の場合はダウンロードされます。
PDFの生成を無効
チェックすると、このテンプレートの WebAPI をロックします。 一時的に無効にしたい場合に使えます。
公開/非公開
テンプレートの公開/非公開を指定します。 詳細は「公開と非公開について」をご覧下さい。

「登録」ボタンをクリックすると完了です。

なお、登録できるテンプレートの数には上限があります。 詳しくは「FAQ: 利用に関して制限はありますか?」をご覧下さい。

修正・削除する

修正又は削除する場合は、テンプレート一覧の「編集(鉛筆アイコン)」ボタンか「削除(ゴミ箱)」ボタンをクリックします。

一覧から修正/削除する

また、テンプレート詳細画面でも可能です。

詳細画面から修正する

詳細画面の削除ボタンは最下部にあります。

詳細画面から削除する

公開と非公開について

テンプレートには公開と非公開の2種類があり、主に 3点 について異なります。 また、テンプレートの公開/非公開は、そのテンプレートの WebAPI の利用方法に影響します。

違い1) WebAPI の利用範囲

公開
公開の場合、そのテンプレートの WebAPI が開放されることを意味します。 つまり、API (URI) を知っている人であれば誰でもその API を使って PDF を取得することができる ことになります。 HTMLフォームから API を使う場合はその仕組み上、公開でなければいけません。
非公開
非公開テンプレートの API を利用するには API-Key を同時に送信する必要があります。ご自分の API-Key は アカウントページ で 確認することができます。また、API-Key はアカウントと同様に非常に重要な情報です。 定期的に更新するとともに、その扱いには十分にご注意下さい。
API-Key の詳細及び注意事項については「FAQ: API-Key とはなんですか?」をご覧下さい。

違い2) WebAPI の利用方法

  XML JSON HTML フォーム URL パラメータ
公開 Yes Yes Yes Yes
非公開 Yes Yes No No

違い3) 印刷ページに関する制限

公開/非公開によって、印刷可能なページ数の上限等、その制限も異なります。 詳細は「FAQ: 利用に関して制限はありますか?」をご覧下さい。