RESTful API エンドポイント (confirm)

RESTful API ドキュメント (概説) へ

confirmエンドポイントについて

モデル「contact」に対してのみ有効なエンドポイントです。バリデーションを実行して結果を返します。

エンドポイント

/api/v1/スコープID/contact/confirm/フォームID
/api/v1/1/contact/confirm/1

メソッド

POST

リクエストボディ

※ リクエストボディの代わりにフォームで生成した HTMLフォームのパラメタを POSTすることも可能です。

Identifier : コンタクトの識別子です。
Language : 言語を指定します。
Permalink : フォームに URLが存在する場合、そのURL
ObjectId : Permalinkを指定しない時、どのオブジェクトに対するフォームであるかを指定する場合にオブジェクトの IDを指定します。
Model : Permalinkを指定しない時、どのオブジェクトに対するフォームであるかを指定する場合にオブジェクトのモデル名を指定します。

これらのキーはすべて省略可能です。すべて大文字で始まることに注意してください。これらのキーと別に、フォーム項目のベースネームと値を配列で追加します。

{
    "Identifier": "contact_us",
    "Language": "ja",
    "Permalink":"https:\/\/localhost\/01\/contact\/website_contact_us.html",
    "website_your_name": "野田純生",
    "website_email": "webmaster@alfasado.jp",
    "website_subject": "テスト投稿",
    "website_message": "テスト投稿です",
    "website_privacy_policy": "agree"
}

ファイルを添付する時

ファイル名、設問のベースネームを付けて送信します。

{
    "Identifier": "contact_us",
    "Language": "ja",
    "Permalink":"https:\/\/localhost\/01\/contact\/website_contact_us.html",
    "website_your_name": "野田純生",
    "website_email": "webmaster@alfasado.jp",
    "website_subject": "テスト投稿",
    "website_message": "テスト投稿です",
    "website_privacy_policy": "agree",
    "attachmentfiles": [
        {
            "name": "ファイル名.docx",
            "basename": "website_attachment1",
            "file": {
                "Data": "data:application\/vnd.openxmlformats-officedocument.wordprocessingml.document;base64,............"
            }
        }
    ]
}

レスポンス(成功時)

{
    "magic_token": "ebfb7c8cade1150b2734e46e7ca5ca5d",
    "params": {
        "Identifier": "contact_us",
        "Language": "ja",
        "Permalink": "https:\/\/localhost\/01\/contact\/website_contact_us.html",
        "website_your_name": "野田純生",
        "website_email": "webmaster@alfasado.jp",
        "website_subject": "テスト投稿",
        "website_message": "テスト投稿です",
        "website_privacy_policy": "agree"
    }
}

※ バリデーション・エラーがあった時

{
    "messages": [
        "お名前は必須です。",
        "正しいメールアドレスを指定してください。"
    ],
    "errors": {
        "website_your_name": "お名前は必須です。",
        "website_email": "正しいメールアドレスを指定してください。"
    },
    "params": {
        "Identifier": "contact_us",
        "Language": "ja",
        "Permalink": "https:\/\/localhost\/01\/contact\/website_contact_us.html",
        "website_your_name": "",
        "website_email": "webmaster",
        "website_subject": "テスト投稿",
        "website_message": "テスト投稿です",
        "website_privacy_policy": "agree"
    }
}

レスポンス・エラー

共通レスポンスエラーについてはこちらを参照ください。

何らかのエラーで一時トークンが発行できなかった時

{
    "status": 500,
    "message": "An error occurred while generating token."
}