Отправка профиля клиента в сценарий

В этой статье мы расскажем, как с помощью API-запроса отправить в сценарий профиль, который уже есть в базе.

подсказка

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

Обратите внимание, что профили при таком запуске входят в сценарий через ноду "По умолчанию".

Получение API-токена

API-токен — это ключ доступа к платформе через API. Он используется в любом API-запросе.

Найти токен можно в настройках платформы Altcraft, в разделе "Токены". Если у вас ещё нет токена, создайте его, нажав на соответствующую кнопку:

предупреждение

API-токен могут создать только мастер-пользователи. Если у вас нет прав для создания токена, обратитесь к пользователю с правами мастера.

Установка и запуск Postman

Для работы с API-запросами вам понадобится приложение, позволяющее отправлять и принимать их.

1. Скачайте и установите приложение Postman или откройте его веб-версию.

2. Выберите метод POST для вашего запроса.

3. Перейдите на вкладку Body и выберите режим raw. Убедитесь, что выбран формат JSON.

URL-адрес запроса

Для отправки запроса на сервер вам необходимо ввести его URL. Он индивидуален для каждого запроса. Например, для запроса на импорт профиля URL-адрес будет таким:

https://example.com/api/v1.1/workflows/start/

Замените example.com на домен, на котором развернута ваша платформа. Вы можете скопировать адрес прямо из адресной строки:

Создание запроса

Перейдем к написанию запроса. Предположим, мы хотим отправить в сценарий #3 профиль подписчика с ID 66acb337240d5213037986d8. Запрос может выглядеть так:

{
  "token": "abcdefghklmnopqrstzxc",
  "id": 3,
  "matching": "profile_id",
  "profile_id": "66acb337240d5213037986d8"
}

• "token" — ваш API-токен. Подробнее о том, где можно его найти, написано в начале статьи.
• "id" — идентификатор сценария. Он указан рядом с названием сценария справа от знака # . id сценария — это всегда число, не путайте его с названием.
• "matching" и "profile_id" — параметры, по которым запрос найдёт в базе необходимый профиль. В данном случае используется поиск по идентификатору профиля.

к сведению

Идентификатор профиля можно найти здесь:

Подробнее о параметре matching

Параметр matching определяет, по какому полю будет происходить поиск профиля в базе данных. В платформе доступно несколько режимов поиска, например, платформа может искать профиль по email-адресу, номеру телефона, системному идентификатору или по любому значению, которое вы храните в дополнительном поле базы.

Главное, чтобы поле, по которому вы запускаете поиск в базе, было уникальным для профиля, т.е. значение этого поля не должно совпадать у разных профилей в одной базе.

Если вы хотите найти профиль по его email, то matching будет выглядеть так:

{
     "matching": "email",
     "email": "example@example.com"
}

Поиск профиля по телефону:

{
     "matching": "phone",
     "phone": "+79000000000"
}

Поиск профиля по идентификатору:

{
     "matching": "profile_id",
     "profile_id": "012452gf62fcd71fjh8ec0"
}

Поиск профиля по значению дополнительного поля:

{
     "matching": "custom",
     "field_name": "CRM_ID",
     "field_value": "12345"
}

где CRM_ID — это название поля, а 12345 — значение этого поля у профиля.

подсказка

Больше информации о матчинге вы найдете в этой статье.

подсказка

Обратите внимание на синтаксис вашего запроса. Лишние символы или незакрытые скобки могут привести к ошибке.

Отправка запроса

Чтобы отправить запрос, нажмите кнопку Send в Postman. При успешном выполнении вы получите сообщение об успешной отправке запроса:

Если что-то пошло не так, в ответном сообщении будет указан номер и описание ошибки:

Если у вас не получилось самостоятельно устранить ошибку, передайте номер и описание ошибки в службу поддержки Altcraft.

подсказка

В статье описывается лишь часть возможных параметров для данного запроса. С остальными параметрами можно ознакомиться здесь.