コンテンツにスキップ

API

URL

帳票出力APIのリクエストを送る場合、以下のURLにリクエストしてください。

https://api.createform-cloud.jp/api/forms/{formId}

※{formId}には帳票出力を行う帳票IDを記載して下さい。
例：https://api.createform-cloud.jp/api/forms/F12346789

認証

Create!Form Cloudでは帳票出力時にお客様のテナント情報を識別するためにAPIトークンを使用して認証を行います。
帳票出力APIを実行する場合はリクエストヘッダーに以下の情報を含めてください。

'x-cfc-api-token': apiToken,

apiTokenの場所にはAPI画面から取得したAPIトークンを記載してください。
プログラム上でヘッダーや、パラメータを指定する方法は、サンプルコード生成で生成したサンプルコードを参考にすることができます。

補足情報

ZIPデータソースの作成方法

  • ZIPファイルを作成する際は、フォルダーに対してのZIP圧縮を行うのではなく、ファイルに対してZIP圧縮を行う必要があります

    • Windowsの場合は、ZIPにしたいファイルを全て選択し、右クリックメニューから「圧縮」を行ってください

    Warning

    ZIPファイル内には、必要なデータソースのみを含めてください。
    不要なデータソースが含まれていると、帳票出力が正常に動作しないことがあります。

イメージ変数・PDF変数の指定方法

  • イメージ変数で使用できる画像フォーマットはランタイムによって異なります

  • データソース（CSV・TXT・XML）には、出力するイメージ・PDFをファイル名で指定します
    ※パッケージ版では絶対パスをデータソース内で指定しますが、Create!Form Cloudではファイル名を指定します

    CSVの中身の例

    sample.csvの中身は以下のような文字列になります。

    画像,PDF
sample.png,sample.pdf

  • ZIPデータソースを使用する場合は、データソースと出力するイメージ・PDFをまとめてZIPに圧縮します

    ZIPデータソースを使用する場合の中身の例

    ZIPの中身は以下のような構成になります。

    • sample.csv
    • sample.png
    • sample.pdf