キャンペーン申込・会員登録API

マーケティングプラットフォームにてキャンペーン申込を行うためのAPIです。

メソッド名

application.post

リクエスト情報

アクセスURL

メソッド	URL
POST	https://{domainname}/services/rest/application

URL部パラメータ

パラメータ名	必須	内容
application_flow_id	必須	申込フローID
application_step_id	オプション	申込フローのステップを外部で実現するために使用します。申込フローのどのステップへのリクエストなのか(例：カート、ユーザ情報)をIDで指定します。
lang	オプション	言語を指定します。・ja（日本語）・en（英語） ※ 他言語も利用可能（SMP環境毎に異なるため、「設定」タブの「言語設定」に登録されている言語をご確認ください）
is_update	オプション	追加申込の場合は「1」を指定します。
is_agency	オプション	管理者による代理申込のときは「1」を指定します。
donot_send_mail	オプション	申込完了メール(リード宛&キャンペーン管理者宛)、仮登録通知メール(リード宛&キャンペーン管理者宛)、及び、申込起点ステップメールを送信しない場合は「1」を指定します。
update_key	オプション	is_updateオプションが「1」の場合の更新キーを指定します。設定値は、システム設定一覧の「Webサービス経由でのリード登録時の更新キーの>利用」をご覧ください。複数指定する場合は「:」をURLエンコードした「%3A」で区切ります。なお、本項目に値を設定した場合、「Webサービス経由でのリード登録時の更新キーの利用」で設定した値よりも優先されます。
ignore_itemcheck	オプション	要素のエラーチェック(必須チェック、型チェック)を行いたくない場合は「1」を指定します。
action	オプション	申込フローのステップを外部で実現するために使用します。申込フローの何番目のステップへのリクエストなのかを表します。

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

★ エレメント名：Application ★ データ型：ApplicationType

カラム名	データ型	内容
VisitorData	VisitorDataType	リード情報
Transaction	TransactionForApplicationType	申込情報
Enquete	EnqueteType	アンケート情報
Payment	PaymentType	支払いタイプ情報
Billing	BillingType	請求書情報
Discount	ApplicationDiscountType	割引情報

★ エレメント名：VisitorData ★ データ型：VisitorDataType

カラム名	データ型	内容
Id	string	リードID ※ 追加申込(is_update=1)の場合のみ使用します。
LoginId	string	ログインID ※ 制限事項参照
LoginPassword	string	ログインパスワード ※ 制限事項参照
Name1	string	姓
Name2	string	名
Name3	string	ミドルネーム
Name1Ka	string	姓フリガナ
Name2Ka	string	名フリガナ
CompanyName	string	会社名
CompanyNameKa	string	会社名フリガナ
Division	string	部署
Position	string	役職
Zip1	string	郵便番号1
Zip2	string	郵便番号2
Zip3	string	郵便番号3
Country	CountryType	国名 CountryId：CountryName
Prefecture	PrefectureType	都道府県IDと都道府県名の対応表参照
Address1	string	住所1
Address2	string	住所2
Address3	string	住所3
Address4	string	住所4
Address5	string	住所5
Tel	string	電話番号
SubTel	string	電話番号予備
Fax	string	ファックス番号
Email	string	E-Mail アドレス
SubEmail	string	E-mailアドレス予備
PermissionType	PermissionTypeType	最新情報等をメールで受け取りますか PermissionTypeId：PermissionTypeName 1：希望する 2：希望しない
Language	LanguageType	使用言語 LanguageId：LanguageName 1：日本語 2：英語 ※ 他言語も利用可能（SMP環境毎に異なるため、「設定」タブの「言語設定」に登録されている言語をご確認ください）
Memo	string	メモ
Membership	MembershipType	ログインIDの使用 MembershipId：MembershipName 0：使用しない 1：使用する
EmailValid	EmailValidType	E-mailアドレスの有効フラグ EmailValidId : EmailValidName 0 : 無効 1 : 有効
SubEmailValid	SubEmailValidTypebr	E-mailアドレス予備の有効フラグ SubEmailValidId : SubEmailValidName 0 : 無効 1 : 有効
Attribute{aid}	-	追加項目追加項目について/追加項目のデータ型参照 ※ デフォルト値のある追加項目は値の指定がなければ、デフォルト値で登録されます。

★ エレメント名：Transaction ★ データ型：TransactionForApplicationType

カラム名	データ型	内容
Language	LanguageType	登録時言語 LanguageId：LanguageName 1：日本語 2：英語
CartList	CartListType	カート一覧 Cart SsDataId：NumberOfApplication キャンペーンID（またはサブキャンペーンID）：申込数 ※キャンペーンIDかサブキャンペーンIDかはApplicationFlowIdにて関連するキャンペーンタイプで判別されます。

★ エレメント名：Enquete ★ データ型：EnqueteType

カラム名	データ型	内容
Id	string	アンケート回答情報ID
VisitorId	string	リードID
HistoryId	string	アンケート履歴ID
Attribute{aid}	-	追加項目追加項目について/追加項目のデータ型参照

★ エレメント名：Payment ★ データ型：PaymentType

カラム名	データ型	内容
Payment	PaymentType	支払タイプ PaymentTypeId：PaymentTyteName 1：クレジットカード決済 2：銀行振込 3：コンビニ決済 4：無料 5：ペイジー決済(Pay-Easy) 6：コンビニ決済(セブンイレブン) 7：コンビニ決済(ローソン・セイコーマート・ミニストップ) 8：コンビニ決済(ファミリーマート) 9：コンビニ決済(サークルKサンクス・デイリーヤマザキ等、その他)

★ エレメント名：Billing ★ データ型：BillingType

カラム名	データ型	内容
Id	string	請求先ID
VisitorId	string	リードID
Name1	string	姓
Name2	string	名
Name3	string	請求先ミドルネーム
Name1Ka	string	姓フリガナ
Name2Ka	string	名フリガナ
CompanyName	string	会社名
CompanyNameKa	string	会社名フリガナ
Division	string	部署
Position	string	役職
Zip1	string	郵便番号1
Zip2	string	郵便番号2
Zip3	string	郵便番号3
Country	CountryType	国名 CountryId：CountryName
Prefecture	PrefectureType	都道府県IDと都道府県名の対応表参照
Address1	string	住所1
Address2	string	住所2
Address3	string	住所3
Address4	string	住所4
Address5	string	住所5
Tel	string	電話番号
SubTel	string	電話番号予備
Fax	string	ファックス番号
Email	string	E-mailアドレス
SubEmail	string	E-mailアドレス予備

★ エレメント名：Discount ★ データ型：ApplicationDiscountType

カラム名	データ型	内容
Code	string	割引コード

レスポンス情報

レスポンスコード

コード	内容
201	正常終了

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Result

カラム名	データ型	内容
ResultStatus	string	結果 success：成功 failure：失敗
ResultDetail	ResultDetailType	結果の詳細
ErrorsList	ErrorListType	エラーの詳細

XMLサンプル

リクエストXMLサンプル

<?xml version='1.0' encoding='UTF-8'?>
<ApplicationList xmlns="http://smartseminar.jp/" version="1.5">
　<Application>
　　<Payment>
　　　<PaymentType>
　　　　<PaymentTypeId>2</PaymentTypeId>
　　　　<PaymentTypeName>銀行振込</PaymentTypeName>
　　　</PaymentType>
　　</Payment>
　　<VisitorData>
　　　<Prefecture>
　　　　<PrefectureId>1</PrefectureId>
　　　　<PrefectureName>北海道</PrefectureName>
　　　</Prefecture>
　　　<Name1>新規申込</Name1>
　　　<Name2>テスト太郎</Name2>
　　　<Country>
　　　　<CountryId></CountryId>
　　　　<CountryName></CountryName>
　　　</Country>
　　　<Email>aa@aa.aa</Email>
　　　<LoginId>ssapitest884</LoginId>
　　　<PermissionType>
　　　　<PermissionTypeId></PermissionTypeId>
　　　　<PermissionTypeName></PermissionTypeName>
　　　</PermissionType>
　　　<Address1>札幌市</Address1>
　　　<Address2>中央区</Address2>
　　　<Address3>双子山</Address3>
　　　<Address4>111</Address4>
　　　<Address5>ハイツ○○ ×××号室</Address5>
　　　<Tel>111-111-1111</Tel>
　　　<SubTel>222-222-2222</SubTel>
　　　<Fax>333-333-3333</Fax>
　　　<CompanyName>会社名１</CompanyName>
　　　<CompanyNameKa>カイシャメイフリガナ</CompanyNameKa>
　　　<Division>部署１</Division>
　　　<Position>役職１</Position>
　　　<Zip1>111</Zip1>
　　　<Zip2>1111</Zip2>
　　　<Zip3>11</Zip3>
　　</VisitorData>
　　<Transaction>
　　　<Language>
　　　　<LanguageId></LanguageId>
　　　　<LanguageName></LanguageName>
　　　</Language>
　　　<CartList>
　　　　<Cart>
　　　　　<SsDataId>2</SsDataId>
　　　　　<NumberOfApplication>1</NumberOfApplication>
　　　　</Cart>
　　　</CartList>
　　</Transaction>
　　<Enquete>
　　　<Attribute1>アンケートの答え</Attribute1>
　　</Enquete>
　　<Billing>
　　　<Prefecture>
　　　　<PrefectureId></PrefectureId>
　　　　<PrefectureName></PrefectureName>
　　　</Prefecture>
　　　<Country>
　　　　<CountryId></CountryId>
　　　　<CountryName></CountryName>
　　　</Country>
　　</Billing>
　　<Discount>
　　　<Code>A-1</Code>
　　</Discount>
　</Application>
</ApplicationList>

レスポンスXMLサンプル

★ 成功時

<?xml version='1.0' encoding='UTF-8'?>
<ApplicationList xmlns="http://smartseminar.jp/" version="1.5">
　<Application>
　　<Result>
　　　<ResultStatus>success</ResultStatus>
　　　<ResultDetail>
　　　<VisitorId>1</VisitorId>
　　　<ApplicationId>2</ApplicationId>
　　</ResultDetail>
　</Result>
</Application>
</ApplicationList>

★ 失敗時

<?xml version='1.0' encoding='UTF-8'?>
<ApplicationList xmlns="http://smartseminar.jp/" version="1.5">
　<Application>
　　<Result>
　　　<ResultStatus>failure</ResultStatus>
　　　<ResultDetail>
　　　<ErrorsList>
　　　　<Error>
　　　　　<Name>name1</Name>
　　　　　<Message>必ず入力してください</Message>
　　　　</Error>
　　　</ErrorsList>
　　　</ResultDetail>
　　</Result>
　</Application>
</ApplicationList>

制限事項

マーケティングプラットフォームAPIのリクエストパラメータに記載されている必須カラムと、対応するマーケティングプラットフォームの必須カラムは、整合性がとれている必要があります。
例えば、マーケティングプラットフォームAPIでは必須でないカラムであっても、マーケティングプラットフォームのカラムが必須であった場合、APIによるデータ更新処理時に必須エラーが発生します。
メソッド実行時、パラメータを設定しない、またはパラメータを空にするとSMPが自動的に値を設定する（デフォルトでこれらの値が入るように設定されている）項目があります。
- Country（CountryId=1, CountryName=Afganistan）
- Prefecture（PrefectureId=48, PrefectureName=null）
- PermissionType（PermissionTypeId=1, PermissionTypeName=希望する）
- InspectionType（InspectionTypeId=3, InspectionTypeName=未検閲）
- RegistrationType（RegistrationTypeId=1, RegistrationTypeName=本登録）
- Language（LanguageId=1, LanguageName=日本語）
- Membership（MembershipId=1, MembershipName=希望する）
- TransactionCodeAllSeminar(システムによって割り振られます)
- TransactionCodeSeminar(システムによって割り振られます)
- VisitordataCodeAllSeminarr(システムによって割り振られます)
- VisitordataCodeSeminarr(システムによって割り振られます)
ログインID・パスワードは、URL部のパラメータ is_update = 1 （追加申込）の場合は、リクエストパラメータに設定しても更新されません。
visitor.get のレスポンスに含まれる以下の項目は、application.post では登録できません。
- DateRegist
- DateUpdate
- EmailSendErrorCount
- EmailValid
- EmailValidDateUpdate
- Id
- SubEmailSendErrorCount
- SubEmailValid
- SubEmailValidDateUpdate
- UnsubscribeDate
- UnsubscribeStatus
- UserId
- DataId
- DateRegist
- LatestFlag

APIによるキャンペーンの申込について

マーケティングプラットフォームAPIは、リード情報やアンケート情報などの各要素（テーブル）のデータ取得、新規登録、更新、削除の他に、それぞれの要素を組み合わせたオペレーション（キャンペーンの申込、キャンセル）を行うことができます。

キャンペーンへの新規申込

キャンペーンに新規に申込する場合は、application.postメソッドを使用します。前提条件として、マーケティングプラットフォーム側でキャンペーンに申込の準備が済んでいる必要があります。

キャンペーンへの申込用パラメータ

application.postのリクエストは、URL部パラメータとHTTPメッセージボディ部を使用して申込対象のキャンペーンを特定します。具体的には、URL部パラメータの申込フローIDとHTTPリクエストボディ部のキャンペーンID（またはサブキャンペーンID）を指定します。

★ application.postのURL部パラメータ

パラメータ名	内容
application_flow_id	申込フローID
application_step_id	申込ステップID
lang	言語 ja: 日本語 en: 英語
is_update	追加申込の場合は「1」を指定します
is_agency	管理者による代理申込の場合は「1」を指定します
update_key	追加申込の場合の更新キーを指定します。「Webサービス経由でのリード登録時の更新キーの利用」で設定した値よりも優先されます。複数指定する場合は「:」をURLエンコードした「%3A」で区切ります。
ignore_itemcheck	要素のエラーチェック(必須チェック、型チェック)を行いたくない場合は「1」を指定します

申込フローとは、マーケティングプラットフォームにWeb画面から申し込む場合に使用する画面です。申込フローIDは、マーケティングプラットフォームの以下のURLのID（例では123）に対応します。

https://sample.smartseminar.jp/public/application/add/123

★ application.postのHTTPメッセージボディ部 HTTPメッセージボディ部にキャンペーンID（またはサブキャンペーンID）および申込数を指定します。

申込数を指定するHTTPリクエストボディのXMLサンプル

<ApplicationList>
　<Application>
　<Transaction>
　　<CartList>
　　　<Cart>
　　　　<SsDataId>2</SsDataId>
　　　　<NumberOfApplication>1</NumberOfApplication>
　　　</Cart>
　　</CartList>
　　</Transaction>
　</Application>
</ApplicationList>

カラム名	内容
SsDataId	キャンペーンIDまたはサブキャンペーンID
NumberOfApplication	申込数

SsDataIdは、キャンペーンIDまたはサブキャンペーンIDを指定します。キャンペーンIDとサブキャンペーンIDの判別は、URL部パラメータのApplication_flow_id（申込フローID）により自動的に判別されます。

キャンペーンへの追加申込

既に登録済みのユーザーを使って別のキャンペーンに申し込む場合、下記の設定を行う必要があります。

URLパラメータ [is_update=1]
システム設定 [Webサービス経由でのリード登録時の更新キーの利用]

★ URLパラメータ「is_update=1」 APIコール時のURL部パラメータに”is_update=1”を指定します。

★ システム設定「Webサービス経由でのリード登録時の更新キーの利用」マーケティングプラットフォームの管理画面から、「設定」 > 「システム設定一覧」 > 「Webサービス経由でのリード登録時の更新キーの利用」にリードを一意にするためのキーを設定します。

例えば、リードIDをキーする場合、「id」を設定します。ここで設定したカラムは、リクエスト時に必須となります。設定に利用できるキーは下記です。

カラム名	内容
id	リードID
name1	姓
name2	名
name3	ミドルネーム
name1_ka	姓（カナ）
name2_ka	名（カナ）
division	部署
position	役職
zip1	郵便番号１
zip2	郵便番号２
zip3	郵便番号３
address1	住所１
address2	住所２
address3	住所３
address4	住所４
address5	住所５
tel	電話番号
sub_tel	電話番号（予備）
fax	FAX番号
email	Emailアドレス
sub_email	Emailアドレス（予備）

キャンペーンへのキャンセル

既に申込まれたキャンペーンをキャンセルする場合は、application.deleteメソッドを使用します。

以下のURLをリクエストすることにより、キャンペーン申込がキャンセルされます。例）申込ID＝123のキャンペーン申込をキャンセルする場合

https://sample.smartseminar.jp/services/rest/application?api_sig=44c477c44e599f6f4f303b4d41a002b03acb9b99&id=123&token=75dc15c60c6446e422fe541644688c8609285815&api_key=55b985f4994bf940b63f6bfb0aec3f70

★ application.deleteのURL部パラメータ

パラメータ名	内容
id	キャンセルする申込ID
donot_send_mail	キャンセルのメールを送信しない場合は「1」を指定

変更/キャンセル履歴検索

キャンペーン申込内容の変更およびキャンセルされたデータを取得する場合は、以下の検索条件を使用します。

★ CancelFlag = 1 かつ CancelParentId = null 例）変更およびキャンセルとして扱われる申込情報を取得する

https://sample.smartseminar.jp/services/rest/visitor/application?search_operator2=eq&search_value1=1&search_operator1=eq&api_key=55b985f4994bf940b63f6bfb0aec3f70&search_key1=CancelFlag&api_sig=44c477c44e599f6f4f303b4d41a002b03acb9b99&search_key2=CancelParentId&search_value2=&token=d2c2cf8f03e687e09095f3b4237ee0891678b16b