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

SMPにてキャンペーン申込を行うためのAPIです。

メソッド名

application.post

リクエスト情報

アクセスURL

URL部パラメータ

HTTPリクエストヘッダ

なし

HTTPリクエストボディ

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

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

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

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

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

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

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

レスポンス情報

レスポンスコード

HTTPレスポンスヘッダ

なし

HTTPレスポンスボディ

★ エレメント名：Result

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>

制限事項

• SHANON MARKETING PLATFORM APIのリクエストパラメータに記載されている必須カラムと、対応するSMPの必須カラムは、整合性がとれている必要があります。
• 例えば、SHANON MARKETING PLATFORM APIでは必須でないカラムであっても、SMPのカラムが必須であった場合、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によるキャンペーンの申込について

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

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

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

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

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

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

申込フローとは、SMPにWeb画面から申し込む場合に使用する画面です。 申込フローIDは、SMPの以下の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を指定します。キャンペーンIDとサブキャンペーンIDの判別は、URL部パラメータのApplication_flow_id（申込フローID）により自動的に判別されます。

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

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

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

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

★ システム設定「Webサービス経由でのリード登録時の更新キーの利用」 SMPの管理画面から、「設定」 > 「システム設定一覧」 > 「Webサービス経由でのリード登録時の更新キーの利用」にリードを一意にするためのキーを設定します。

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

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

既に申込まれたキャンペーンをキャンセルする場合は、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部パラメータ

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

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

★ 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