xml

🚧
В инструкции описаны примеры POST-запросов. Интеграция с Mindbox не будет работать, если использовать запросы из примеров ниже без редактирования.
Операции именно под вашу задачу создает и описывает в техническом задании менеджер проекта, если у вас нет такого документа, то обратитесь к вашему менеджеру.

Описание метода

Осуществляется с помощью POST-запроса. Название операции и набор принимаемых полей настраиваются в системе Майндбокс. Подробней про вызов метода можно прочитать здесь.

POST https://api.mindbox.ru/v3/operations/{синхронная/асинхронная операция}?endpointId={уникальный идентификатор сайта/мобильного приложения/и т.п.}&operation={название операции}&deviceUUID={уникальный идентификатор устройства}

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey {Секретный ключ, обязательность уточнить у менеджера}

<operation>
  <customer>
    <ids>
      <webSiteUserId>{Идентификатор клиента}</webSiteUserId>
    </ids>
    <email>{Емэйл клиента}</email>
    <mobilePhone>{Мобильный телефон}</mobilePhone>
    <lastName>{Фамилия клиента}</lastName>
    <firstName>{Имя клиента}</firstName>
    <birthDate>{Дата рождения в формате YYYY-MM-DD}</birthDate>
    <password>{Пароль}</password>
    <area>
      <ids>
        <externalId>{Идентификатор географической зоны клиента}</externalId>
      </ids>
    </area>
    <subscriptions>
      <subscription>
        <pointOfContact>{Канал коммуникации Email/SMS/тд}</pointOfContact>
        <topic>{Тематика рассылок}</topic>
      </subscription>
    </subscriptions>
    <customFields>
      <Дополнительное поле>{Значение дополнительного поля}</Дополнительное поле>
      <Дополнительное поле со множеством значений>
        <value>{Значение дополнительного поля}</value>
        <value>{Значение дополнительного поля}</value>        
      </Дополнительное поле со множеством значений>
    </customFields>
  </customer>
</operation>

Примеры операций

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=registartion

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey D061p764m85bklq

<operation>
  <customer>
    <ids>
      <bitrixId>346257</bitrixId>
    </ids>
    <email>[email protected]</email>
    <mobilePhone>79374134389</mobilePhone>
    <fullName>Петров Иван</fullName>
    <password>Qwerty</password>
    <area>
      <ids>
        <externalId>Moscow</externalId>
      </ids>
    </area>
    <subscriptions>
      <subscription>
        <pointOfContact>Sms</pointOfContact>
        <topic>News</topic>
      </subscription>
      <subscription>
        <pointOfContact>Email</pointOfContact>
        <topic>Digest</topic>
      </subscription>
    </subscriptions>
    <customFields>
      <b2b>true</b2b>
      <childrenNames>
        <value>Петя</value>
        <value>Маша</value>
      </childrenNames>
    </customFields>
  </customer>
</operation>

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=WebSiteLogin

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey D061p764m85bklq

<operation>
  <customer>
    <ids>
      <bitrixId>346257</bitrixId>
    </ids>
    <email>[email protected]</email>
    <mobilePhone>79374134389</mobilePhone>
  </customer>
</operation>

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=callback

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey D061p764m85bklq

<operation>
  <customer>
    <mobilePhone>79374134389</mobilePhone>
  </customer>
</operation>

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=popup

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey D061p764m85bklq

<operation>
  <customer>
    <email>[email protected]</email>
    <subscriptions>
      <subscription>
        <pointOfContact>Email</pointOfContact>
      </subscription>
    </subscriptions>
  </customer>
</operation>

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRu&operation=RegistartionByReferrealCode

Accept: application/xml
Content-Type: application/xml
Authorization: SecretKey D061p764m85bklq

<operation>
   <customer>
      <email>{Email потребителя}</email>
      <lastName>{Имя}</lastName>
      <firstName>{Фамилия}</firstName>
      <middleName>{Отчество}</middleName>
   </customer>
   <referencedCustomer>
      <ids>
         <referralCode>{Реферальный код}</referralCode>
      </ids>
   </referencedCustomer>
</operation>

POST https://api.mindbox.ru/v3/operations/async?endpointId=MindboxRuMobApp&operation=registartion&deviceUUID=ab2d192a-9992-4dcd-987d-927715fabf94

Accept: application/xml
Content-Type: application/xml
Authorization: Mindbox secretKey="D061p764m85bklq"
X-Customer-IP: 192.323.32.1

<operation>
  <customer>
    <ids>
      <bitrixId>346257</bitrixId>
    </ids>
    <email>[email protected]</email>
    <mobilePhone>79374134389</mobilePhone>
    <fullName>Петров Иван</fullName>
    <password>Qwerty</password>
    <area>
      <ids>
        <externalId>Moscow</externalId>
      </ids>
    </area>
    <mobileApplicationInstallation>
      <id>{IntallationId - идентификатор установки приложения}</id>
    </mobileApplicationInstallation>
    <subscriptions>
      <subscription>
        <pointOfContact>MobilePush</pointOfContact>
        <topic>SweetsOfLife</topic>
        <isSubscribed>false</isSubscribed>
        <valueByDefault>true</valueByDefault>
      </subscription>
    </subscriptions>
    <customFields>
      <b2b>true</b2b>
      <childrenNames>
        <value>Петя</value>
        <value>Маша</value>
      </childrenNames>
    </customFields>
  </customer>
</operation>

Ответ

<result>
    <status>Success</status>
</result>

<result>
    <status>ValidationError</status>
    <validationMessages>
        <validationMessage>
            <message>Потребитель с таким адресом электронной почты уже зарегистрирован</message>
            <location>/operation/customer/email</location>
        </validationMessage>
        <validationMessage>
            <message>Потребитель с таким мобильным телефоном уже зарегистрирован</message>
            <location>/operation/customer/mobilePhone</location>
        </validationMessage>
    </validationMessages>
</result>

В зависимости от настроек операции при повторной регистрации мы можем либо редактировать потребителя, либо возвращать валидационную ошибку. Валидационная ошибка может возникать из-за повторной регистрации с уникальным идентификатором, который уже есть в системе или из-за повторной регистрации контактов с доступом к аккаунту. Подробнее можно прочитать здесь и здесь .

Updated about 1 month ago