APITemplate (Independent Publisher)

APITemplate.io サービスを使用すると、PDF ドキュメントと画像を作成し、テンプレートを管理できます。 コーディングなしで、再利用可能なテンプレートからソーシャル メディアの画像、バナー、または PDF を生成します。

このコネクタは、次の製品および地域で利用可能です:

Service クラス 地域
Logic Apps 標準 以下を除くすべての Logic Apps 地域 :
     -   Azure 政府の地域
     -   Azure 中国の地域
     -   国防総省 (DoD)
Power Automate プレミアム 以下を除くすべての Power Automate 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   国防総省 (DoD)
Power Apps プレミアム 以下を除くすべての Power Apps 地域 :
     -   米国政府 (GCC)
     -   米国政府 (GCC High)
     -   21Vianet が運用する中国のクラウド
     -   米国国防総省 (DoD)
お問い合わせ先
件名 Troy Taylor
[URL] https://www.hitachisolutions.com
メール ttaylor@hitachisolutions.com
Connector Metadata
発行者 Troy Taylor
Web サイト https://apitemplate.io/
プライバシー ポリシー https://apitemplate.io/privacy-policy/
カテゴリ コンテンツとファイル

接続の作成

コネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

件名 タイプ 内容 必要
API キー securestring この API の API キー True

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 100 60 秒

アクション

PDF の作成

この要求により、JSON データとテンプレートを含む PDF ファイルが作成されます。 同期および非同期の PDF 生成をサポートします。

PDF テンプレートの取得

PDF テンプレートに関する情報を取得します。

PDF テンプレートを更新

このアクションにより、PDF テンプレートが更新されます。

オブジェクトを削除

CDN から PDF または画像を削除し、トランザクションを削除済みとしてマークします。

テンプレートの一覧を表示します

テンプレートとその情報のリストを取得します。

生成されたオブジェクトのリスト

生成されたすべての PDF と画像のリストを取得します。

画像を作成する

この要求により、JSON データとテンプレートから JPEG ファイル (と PNG ) が作成されます。

複数の PDF をマージする

このアクションは、複数の PDF を 1 つの PDF ファイルにマージ/結合します。

PDF の作成

この要求により、JSON データとテンプレートを含む PDF ファイルが作成されます。 同期および非同期の PDF 生成をサポートします。

パラメーター

名前 キー 必須 説明
テンプレート ID
template_id True string

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

エクスポートの種類
export_type string

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

Expiration
expiration integer

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

出力 HTML
output_html string

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

出力形式
output_format string

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

Filename
filename string

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

大きなリサンプル解像度
image_resample_res string

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

Is CMYK
is_cmyk string

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

クラウド ストレージ
cloud_storage integer

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

Meta
meta string

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

非同期
async string

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

ウェブフック URL
webhook_url string

これは Webhook URL の URL です。これは http:// か https:// から始まり、urlencode である必要があります。 もし async1 に設定されている場合、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] : トランザクションの状態で、successerror になります。 [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

object

戻り値

ResponseSuccessPDFFile
ResponseSuccessPDFFile

PDF テンプレートの取得

PDF テンプレートに関する情報を取得します。

パラメーター

名前 キー 必須 説明
テンプレート ID
template_id string

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

戻り値

ResponseSuccessTemplate
ResponseSuccessTemplate

PDF テンプレートを更新

このアクションにより、PDF テンプレートが更新されます。

パラメーター

名前 キー 必須 説明
テンプレート ID
template_id True string

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

Body
body string

HTML 本文

CSS
css string

css

戻り値

ResponseSuccess
ResponseSuccess

オブジェクトを削除

CDN から PDF または画像を削除し、トランザクションを削除済みとしてマークします。

パラメーター

名前 キー 必須 説明
トランザクション参照
transaction_ref True string

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

戻り値

ResponseSuccessDeleteObject
ResponseSuccessDeleteObject

テンプレートの一覧を表示します

テンプレートとその情報のリストを取得します。

パラメーター

名前 キー 必須 説明
Limit
limit string

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

ページ
offset string

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

Format
format string

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

テンプレート ID
template_id string

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

グループ名
group_name string

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

レイヤー情報あり
with_layer_info string

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

戻り値

ResponseSuccessListTemplates
ResponseSuccessListTemplates

生成されたオブジェクトのリスト

生成されたすべての PDF と画像のリストを取得します。

パラメーター

名前 キー 必須 説明
Limit
limit string

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

ページ
offset string

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

テンプレート ID
template_id string

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

トランザクションの種類
transaction_type string

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

戻り値

ResponseSuccessListObjects
ResponseSuccessListObjects

画像を作成する

この要求により、JSON データとテンプレートから JPEG ファイル (と PNG ) が作成されます。

パラメーター

名前 キー 必須 説明
テンプレート ID
template_id True string

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

Expiration
expiration integer

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

クラウド ストレージ
cloud_storage integer

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

出力画像タイプ
output_image_type string

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

Meta
meta string

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

object

戻り値

ResponseSuccessImageFile
ResponseSuccessImageFile

複数の PDF をマージする

このアクションは、複数の PDF を 1 つの PDF ファイルにマージ/結合します。

パラメーター

名前 キー 必須 説明
Meta
meta string

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

URL
urls True array of string

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

エクスポートの種類
export_type string

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

Expiration
expiration integer

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

クラウド ストレージ
cloud_storage integer

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

戻り値

ResponseSuccessSingleFile
ResponseSuccessSingleFile

定義

ResponseSuccess

名前 パス 説明
Status
status string

Status

ResponseSuccessTemplate

名前 パス 説明
Status
status string

Status

テンプレート ID
template_id string

テンプレート ID

Body
body string

テンプレートの HTML 本文

CSS
css string

テンプレートの CSS

設定
settings string

テンプレートの印刷設定

ResponseSuccessPDFFile

名前 パス 説明
Status
status string

Status

Download URL
download_url string

Download URL

テンプレート ID
template_id string

テンプレート ID

トランザクション参照
transaction_ref string

トランザクション参照

アクション後
post_actions array of object

アクション後。

アイテム
post_actions object

ResponseSuccessImageFile

名前 パス 説明
Status
status string

Status

Download URL
download_url string

Download URL

URL PNG のダウンロード
download_url_png string

URL PNG のダウンロード

テンプレート ID
template_id string

テンプレート ID

トランザクション参照
transaction_ref string

トランザクション参照

アクション後
post_actions array of object

アクション後。

アイテム
post_actions object

ResponseSuccessListTemplates

名前 パス 説明
Status
status string

状態。

テンプレート
templates array of object

テンプレート

アイテム
templates object

ResponseSuccessListObjects

名前 パス 説明
Status
status string

状態。

Objects
objects array of object

オブジェクト。

アイテム
objects object

ResponseSuccessDeleteObject

名前 パス 説明
Status
status string

状態。

ResponseSuccessSingleFile

名前 パス 説明
Status
status string

Status

主 URL
primary_url string

生成された PDF ドキュメント

トランザクション参照
transaction_ref string

トランザクション参照