Как запустить сценарий через API
Как настроить запуск сценария через API и протестировать его через Postman или через Thunder Client в Visual Studio Code. Инструменты работают одинаково — вы можете выбрать любой.
1) Перейдите в «Настройки» → «Сценарии».
2) Нажмите «Создать сценарий».
3) Укажите понятное название (например, Передача из Postman) и нажмите «Создать».
2) Нажмите «Создать сценарий».
3) Укажите понятное название (например, Передача из Postman) и нажмите «Создать».
4) Найдите сценарий в списке и активируйте его.
Шаг 1. Создайте сценарий в платформе XL
1) Перейдите в «Настройки» → «API-ключи».
2) Нажмите «Создать API-ключ», укажите любое понятное название.
2) Нажмите «Создать API-ключ», укажите любое понятное название.
3) В списке ключей нажмите на только что созданный ключ.
4) Установите две галочки в правах доступа:
5) Скопируйте API-ключ, нажав на кнопку копирования, и сохраните в текстовом документе — он пригодится позже при настройке запроса.
4) Установите две галочки в правах доступа:
- Сценарии.
- Запуск сценария.
5) Скопируйте API-ключ, нажав на кнопку копирования, и сохраните в текстовом документе — он пригодится позже при настройке запроса.
Шаг 2. Создайте API-ключ с нужными правами
1) Вернитесь в список сценариев и выберите нужный.
2) В строке браузера скопируйте первую часть ссылки, она выглядит так https://название.сайта/. И вставьте в ваш текстовый документ.
2) В строке браузера скопируйте первую часть ссылки, она выглядит так https://название.сайта/. И вставьте в ваш текстовый документ.
3. В сценарии нажмите на строку «Как запустить сценарий через API».
4. Найдите строку «Вы можете отправить POST-запрос на» — скопируйте оттуда ссылку и добавьте к первой части.
У вас получилась полная ссылка, которая понадобится позже.
4. Найдите строку «Вы можете отправить POST-запрос на» — скопируйте оттуда ссылку и добавьте к первой части.
У вас получилась полная ссылка, которая понадобится позже.
Шаг 3. Сделайте ссылку для отправки запроса
1) Откройте Postman.
2) Откройте раздел «Collection» и нажмите кнопку «New».
2) Откройте раздел «Collection» и нажмите кнопку «New».
3) Выберите из списка HTTP.
4) В открывшемся окне:
- Выберите метод POST.
- В поле «URL» вставьте полную ссылку, которую вы сохранили ранее.
5) Перейдите на вкладку «Headers»:
- В колонке «Key» введите: Authorization.
- В колонке «Value» вставьте ваш скопированный API-ключ.
6) Перейдите на вкладку Body:
- Выберите опцию raw.
- Справа выберите формат JSON.
7) Вставьте JSON-объект. В коде текст АЙДИ_СЦЕНАРИЯ замените на ID вашего сценария.
Шаг 4. Настройте запуск в Postman
В случае, если вы хотите добавить дополнительные атрибуты контакта, чтобы прописать их в параметрах кода, создайте новые атрибуты.
1) Перейдите в раздел «CRM» → «Контакты».
2) Откройте любой контакт → «Управление пользовательскими атрибутами».
1) Перейдите в раздел «CRM» → «Контакты».
2) Откройте любой контакт → «Управление пользовательскими атрибутами».
3) Нажмите «Управление пользовательскими атрибутами» → «Создать поле».
4) Добавьте название, выберите тип атрибута и укажите ключ. Ключ должен состоять из латинских букв, пробелы можно заменить нижним подчеркиванием. Например, just_test.
5) Нажмите кнопку «Создать».
4) Добавьте название, выберите тип атрибута и укажите ключ. Ключ должен состоять из латинских букв, пробелы можно заменить нижним подчеркиванием. Например, just_test.
5) Нажмите кнопку «Создать».
6) Вернитесь на страницу создания запроса в Postman.
7) В теле запроса добавьте значение атрибута. Пример параметра: «just_test»: «123»
7) В теле запроса добавьте значение атрибута. Пример параметра: «just_test»: «123»
Шаг 5. Добавьте дополнительные атрибуты контакта
После завершения настроек параметров кода в Postman, нажмите кнопку «Send», чтобы тестировать отправку данных на платформу Prodamus.XL.
Шаг 6. Протестируйте запуск в Postman
1) Перейдите в раздел «CRM» → «Контакты».
2) Найдите контакт по e-mail, указанному в теле запроса.
3) Убедитесь, что:
2) Найдите контакт по e-mail, указанному в теле запроса.
3) Убедитесь, что:
- Контакт создан;
- Данные обновились;
- Сценарий начал выполняться.
