APITemplate (Independent Publisher)

テンプレート ID。Web コンソール (テンプレートの管理) で取得できます

file または json のいずれかです (デフォルト)。 このオプション json は、JSON オブジェクトを返し、出力 PDF は CDN に保存されます。 パラメータ expiration とともに使用します。 このオプション file は生成された PDF (安全で完全にプライベート) のバイナリ データを返し、応答 HTTP ヘッダー Content-Disposition が添付ファイルに設定されます。

生成されたPDFの有効期限 (デフォルトは 0、永続的に保存)。 0 を使用して、cdn に永続的に保存します。 または、1 分から 10080 分 (7 日) の範囲を使用して、生成された PDF の有効期限を指定します

1 または 0 (デフォルト) のいずれかです。 HTML コンテンツの出力を有効にするには、値を 1 に設定します。JSON 応答で html_url フィールドとして (URL として) 返されます

pdf (デフォルト) または html のいずれかです。 デフォルトでは、PDF の生成です。 ただし、output_format=html を指定して HTML のみを生成することもできます (URL として download_url フィールドとして JSON 応答で返されます)。

デフォルトは UUID (例: 0c93bd9e-9ebb-4634-a70f-de9131848416.pdf)。 これを使用してカスタム ファイル名を指定します、ファイル名の最後は .pdf になります

デフォルトで元の画像を埋め込むため、PDF ファイルのサイズが大きくなります。 オプション 'image_resample_res' を指定すると、現在の PDF の画像を解像度 (DPI) にダウンサンプリングすることで、PDF ファイルのサイズを小さくするのに役立ちます。 共通の値には 72、96、150、300、600 が含まれます。

CMYK カラー プロファイルを使用します。1 = true、0 = false。 デフォルトは 0 です

生成された PDF/画像をストレージ CDN にアップロードします。デフォルトは 1 です。 Post Action を構成して PDF/画像を自分の S3 にアップロードするには、0 に設定してください。

独自の参照用に外部参照 ID を指定します。 list-objects API に表示されます。

1 または 0 のいずれかです (デフォルト)。 0は同期呼び出し (デフォルト) で、 1 は非同期呼び出しです。 PDF を非同期的に生成するには、値を 1 に設定し、API 呼び出しはすぐに戻ります。 PDF ドキュメントが生成されると、URL (webhook_url) に対して HTTP/HTTPS GET が行われ、3 回再試行されます。 もしも async が 1 に設定されていたら、webhook_url は必須です

これは Webhook URL の URL です。これは http:// か https:// から始まり、urlencode である必要があります。 もし async が 1 に設定されている場合、webhook_url を指定する必要があります。 Webhook callbackOnce の形式 PDF が生成されると、次の URL への HTTP/HTTPS GET 呼び出しを開始します: https://[yourwebserver.com]?&primary_url=[primary_url] &transaction_ref=[transaction_ref] &status=[status] &message=[message]。 [yourwebserver.com]: コールバックを処理する Web サービスで webhook_url です。 [primary_url]: PDF ドキュメントへの URL。 [transaction_ref]: トランザクション リファレンス番号。 [status] : トランザクションの状態で、success か error になります。 [message] : 状態メッセージ以下は、サーバーへの Webhook コールバックのサンプルですhttps://yourwebserver.com?&primary_url=https%3A%2F%2Fpub-cdn.apitemplate.io%2F2021%2F06%2Fb692183d-46d7-3213-891a-460a5814ad3f.pdf&transaction_ref=b692183d-46d7-3213-891a-460a5814ad3f&status=success

テンプレート ID。Web コンソール (テンプレートの管理) で取得できます

テンプレート ID。Web コンソール (テンプレートの管理) で取得できます

HTML 本文

css

オブジェクト トランザクション参照

指定された数のレコードのみを取得します。 デフォルトは 300

オフセットは、結果からのレコード数をスキップするのに使用されます。 デフォルトは 0

'PDF' または 'JPEG' でテンプレートをフィルタリングするには

テンプレート ID でテンプレートをフィルタリングするには

グループ名でテンプレートをフィルタリングするには

画像テンプレートのレイヤー情報とともに返します、0=false、1=true です。 デフォルトは 0 です

指定された数のレコードのみを取得します。 デフォルトは 300

オフセットは、結果からのレコード数をスキップするのに使用されます。 デフォルトは 0

テンプレート ID でフィルター処理

取引タイプでフィルターされたオプションは、 PDF、 JPEG または MERGE です

自分のテンプレート ID。Web コンソールで取得できます

分単位の生成された画像の有効期限 (デフォルトは 0、永続的に保存)。 0 を使用して、cdn に永続的に保存します。 または、1 分から 10080 分 (7 日) の範囲を使用して、生成された画像の有効期限を指定します

生成された PDF/画像をストレージ CDN にアップロードして URL を生成します。デフォルトは 1 です。 API Integration で Post Actions を設定している場合、生成された PDF/画像を自分のプライベート S3 にアップロードするには、cloud_storage を 0 に設定してください。 export_type=file の場合、これを無視してください。

出力画像の種類 (JPEGまたはPNG形式)、デフォルトは all。 オプションは、all、jpegOnly、pngOnly です。

独自の参照用に外部参照 ID を指定します。 list-objects API に表示されます。

独自の参照用に外部参照 ID を指定します。 list-objects API に表示されます。

URL 配列。 通常の http/https URL とデータ URL をサポートしています。 通常の URL: URL は http/https で始まります。例: "https://fileserver.com/a1.pdf”")。 データ URL: "data:" スキームで始まる URL。例: "data:application/pdf;base64,JVBERi0xLjIg..[truncated]"

file または json のいずれかです (デフォルト)。 このオプション json は、JSON オブジェクトを返し、出力 PDF は CDN に保存されます。 このオプション file は生成された PDF (安全で完全にプライベート) のバイナリ データを返し、応答 HTTP ヘッダー Content-Disposition が添付ファイルに設定されます。 6MB のファイルサイズ制限があります。

生成されたPDFの有効期限 (デフォルトは 0、永続的に保存)。 0 を使用して、cdn に永続的に保存します。 または、1 分から 43200 分 (30 日) の範囲を使用して、生成された PDF の有効期限を指定します

生成された PDF/画像をストレージ CDN にアップロードします。デフォルトは 1 です。 Post Action を構成して PDF/画像を自分の S3 にアップロードするには、0 に設定してください。