コンテンツにスキップ

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データソースの作成方法

  • マルチデータソース、または、イメージ変数・PDF変数を帳票定義で使用している場合は、ZIPデータソースを使用してください
  • ZIPファイルを作成する際は、フォルダーに対してのZIP圧縮を行うのではなく、ファイルに対してZIP圧縮を行う必要があります
    • Windowsの場合は、ZIPにしたいファイルを全て選択し、右クリックメニューから「圧縮」を行ってください

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

  • イメージ変数・PDF変数を帳票定義内で使用している場合は、出力するイメージ・PDFをデータソースと一緒にZIPに圧縮し、ZIPデータソースとして帳票出力を実行してください

    ZIPの中身の例

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

    • sample.csv
    • sample.png
    • sample.pdf
  • 例)sample.csvには、出力するイメージ・PDFをファイル名で指定します
    ※オンプレミス版では絶対パスをデータソース内で指定しますが、Create!Form Cloudでは下記のようにファイル名を指定します

    CSVの中身の例

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

    画像,PDF
    sample.png,sample.pdf