RestAPI

espar form は、RestAPI を備えた任意のSaaSや社内システムに連携することができます。

以下のサービスと連携する場合は、専用の設定タブが用意されていますのでそれぞれの解説ページをご覧下さい。

このページの解説は、上記以外のSaaSや社内システムに連携する場合に使用できます。各SaaSやシステムのAPI仕様書に基づき適切に設定して下さい。個別のSaaSやシステムのAPIに関する質問を頂戴してもご回答できませんのであらかじめご了承下さい。

準備

連携したいSaaSやシステムのAPI仕様書を用意し、最低限、以下の点を確認して下さい。


API形式	APIにデータを渡す方式
HTTPメソッド	フォーム入力値を連携する時に使用するAPIのメソッド
URL	APIのエントリポイント

基本設定

API形式

APIが値を受け取る形式を指定して下さい。形式ごとに body の中身が異なります。

API形式	説明
フォーム	`name1=value1&name2=value2` のようなクエリパラメタ形式
JSON	フォーム入力要素と入力値を key:value として保持するJSON形式
その他	ボディテンプレートで定めた形式

HTTPメソッド

POST/GETの2種類に対応しています。API仕様書を参考に適切なメソッドを指定します。

API URL

連携したいSaaSやシステムのAPIのエントリポイントをURLで指定します。

高度な設定

espar form のRestAPI連携では、複雑な制御や実装を行うための高度な機能を備えています。

HTTPヘッダー

RestAPI連携では、API URL にHTTPメソッドで指定されたメソッドでリクエストを行います。その際、任意のHTTPヘッダーを付加することができます。

spreadsheet_table

上図のように、リクエスト時に追加したいHTTPヘッダーを:区切りで記入します。記述内容は任意です。上図では、独自の X-Esparform-Source というHTTPヘッダーの値として espfSeminar を指定している例です。(以下にテキストでも記述します)

X-Esparform-Source: espfSeminar

HTTPヘッダーの記述には espar form のメールテンプレートで使用する変数は利用できません。常に固定の文字列を指定頂く必要がありますのでご留意ください。

ボディテンプレート

API形式を「その他」にした時にのみ設定することができます。フォームでの入力値に置き換わる変数を含め、任意の文字列が指定できます。メールテンプレートページのメール本文もご覧下さい。

添付ファイルを送信する

espar form では、添付ファイルを受け付けるフォームを実装できます。「添付ファイルを送信する」のチェックをONにすると、添付ファイルを連携先のSaaSや社内システム渡すことができます。

フォームに <input type="file" name="file1"> のような添付ファイル要素がある場合、APIにPOSTする時のbodyは以下のようになります。(添付ファイル部分のみ記載)

{
  ...(略)...
  "file1": [
    {
      "filename": "test.pdf",
      "mediatype": "application/pdf",
      "data": "JVBERi0xLjMKJc...."
    }
  ]
}

それぞれの値は以下のとおりです。

キー名	値の説明
`filename`	添付されたファイル名
`mediatype`	添付されたファイルの MIME Type
`data`	添付されたファイルをBase64エンコードした文字列

また、<input type="file" name="file1" multiple> のように multiple が指定されていて、複数ファイルを添付できる場合、以下のようになります。

{
  ...(略)...
  "file1": [
    {
      "filename": "test.pdf",
      "mediatype": "application/pdf",
      "data": "JVBERi0xLjMKJc...."
    },
    ...(略)...
    {
      "filename": "sample.png",
      "mediatype": "image/png",
      "data": "EgMCBvYmoKPDwv...."
    }
  ]
}

上記のbodyが渡される前提で、受け取った側で適切に処理を行なって下さい。個別のSaaSの設定やシステムの実装についてはご質問を頂戴しても回答できませんのであらかじめご了承下さい。

API のレスポンスボディを返す

「API のレスポンスボディを返す」のチェックボックスをONにすると、フォームが送信された後に呼び出されるコールバック関数 submit_success_callback で受け取って処理することができます。詳細はコールバックページのsubmit_success_callbackをご覧下さい。