PHP、WordPress以外で作成されたフォームにおいて、Digima v2フォームAPIを使用してDigimaとの連携を行います。

     

    Digima v2フォームAPIの使用方法

    フォーム APIのエンドポイントに送信されたデータは、対象のDigimaアカウントに「ウェブフォームからの問い合わせ」を登録するために使用されます。

    Digimaはこれらの送信されたデータをもとにDigimaの顧客情報を新規作成、あるいは既存の顧客情報を更新します。

    エンドポイント

    Digimaアカウントに「ウェブフォームからの問い合わせ」を登録するには、以下のエンドポイントにPOSTリクエストを送信してください。

    https://form.digima.com/v2/submit

    必須ヘッダ

    APIリクエストには、以下のヘッダが必要です。

    • Content-Type:application/json
    • Accept-Language:jp
    • Authorization:{form_auth_code}

    Authorizationのヘッダー{form_auth_code}について

    アカウントコードとフォームコードを単一のハイフン (-) で結合し、Base64でエンコードした値を設定してください。

    base64_encode({account_code}-{form_code})

    アカウントコード、フォームコードはサポートよりご案内いたします。

    例:アカウントコードが「ABCD1234」、フォームコードが「EFGH5678」の場合、Authorizationヘッダの値は「base64_encode(ABCD1234-EFGH5678)」となります。

      

     

    リクエストボディは、下記のとおりJSONベースの形式である必要があります。

    { 
      "form": {
       "code": "EFGH5678",
       "page_title": "タイトル",
       "page_url": "https://www.example.com",
       "validate_only": false,
       "visit_cookie": "c00k13c0d3",
       ...
      },
      "contact": {
       "first_name": "太郎"
       "first_name_kana": "たろう",
       "last_name": "山田",
       "last_name_kana": "やまだ",
       "email": "yamada.taro@example.com",
       ...
      }
    }

    項目コードの設定

    フォームフィールド

    form配列の中に設定する項目です。

    項目コード

    形式 / 入力制限

    説明

    code ※必須 文字列 / exists Digimaフォームコード
    page_title 文字列 / 最大300文字 HTMLフォームがあるページのタイトル
    page_url 文字列 / 最大300文字 HTMLフォームがあるページのURL
    validate_only ※必須 Boolean / true,false 必ず「false」をして設定ください。「true」の場合、送信されたデータは検証されますが、処理および保存はされず、Digimaの顧客情報の作成または更新は行われません。
    visit_cookie 文字列 送信者のブラウザDigima cookieのコード
    submitter_ip_address 文字列 提出者のIPアドレス
    submitter_user_agent 文字列 / 最大500文字 提出者のユーザーエージェント

    顧客情報フィールド

    contact配列に設定する項目です。項目コードはサポートよりご案内いたします。

    「_id」または 「_name」で終わる属性値に関し、どちらも存在する場合、「_name」より「_id」が
    付く属性情報が常に優先されます。

     

    項目のフィールドと入れ子の設定

    Digimaへ連携する項目に対して、項目コードの設定のほか、フィールドと入れ子の設定が必要です。フィールド、入れ子の情報はサポートよりご案内いたします。

    フィールドの設定

    Digima の顧客情報に存在する項目には2つの種別があります。

    • 基本項目 : 全ての Digima 顧客情報に共通して設定された項目 (メールアドレス、名前など)
    • カスタム項目 : アカウントに追加作成できる項目

    Formオブジェクトの “contact()” の後に 基本項目であれば“staticFields()” 、カスタム項目であれば “customFields()” を設定し、フィールド名を指定してください。

    入れ子の設定

    一部の基本項目について、入れ子の設定が必要です。

    Digima項目のフィールド・入れ子情報と項目コード一覧

    参考:テスト記述ファイル

    cURLを使用し、「ウェブフォームからの問い合わせ」を作成するリクエスト例

    参考:テスト記述ファイル

     

    Digimaに関する"?"にお答えします。

    Digimaサポート窓口 平日10:00~12:00/13:00~17:00

    お問い合わせ