Тестирование API-запросов для CRM-маркетологов

Давно хотел сделать базовую инструкцию, для того, чтобы CRM-маркетолог смог тестировать API-запросы через Postman.

Покажу на примере Mindbox

Как скачать Postman?

1) Переходим по ссылке Download Postman | Get Started for Free

2) Скачиваем версию для вашей операционной системы, к примеру: Windows 64-bit
*ОС можете посмотреть: для Windows: Пуск – Параметры – Система – о системе

3) Скачиваем файл

4) Если аккаунта нет – то создаем , нажимаем «Create Account»

5) Заполняем Email, Username, Password и нажимаем Create Free Account или заходим с помощью вариантов ниже

6) На почту придет код для верификации – вводим его

7) Слева в меню нажимаем «Workspaces»

8) Ещё раз кликаем на созданный Workspace

9) Появится следующее окно Теперь можем перейти к настройке запроса и тестированию.

Как настроить запрос в Postman?

Как правило потребуется заполнить три сущности:
1. URL
2. Headers
3. Body

Начнём:

1) URL

Откуда его брать?

Mindbox:
Если операция уже создана, то идём по следующем пути: Кампании – Список кампаний – Операции – «Выбираем нужную операцию» - Посмотреть описание – Url

Забираем выделенную ссылку. Нужно оставить либо sync, либо async и заменить {Идентификатор точки интеграции} на корректный endpoint.

Его название можно посмотреть, либо в логах -> перейти по кнопке «Посмотреть логи интеграций» , либо в разделе Интеграции – Мониторинг интеграций и выбрать нужную интеграцию. Там же можно взять ключ, который нам понадобится в разделе «Headers»

Итого у вас должен получится url формата: https://api.mindbox.ru/v3/operations/sync?endpointId=cindrom_samozvanza =Order.Create

2) Headers

Нужно заполнить 3 поля
Если JSON, то:
Content-Type: application/json; charset=utf-8
Accept: application/json
Authorization: SecretKey {Секретный ключ}

Если XML, то:
Content-Type: application/xml; charset=utf-8
Accept: application/xml
Authorization: SecretKey {Секретный ключ}
*секретный ключ не всегда может понадобится

Получится так:

Где взять секретный ключ?
Интеграции – Мониторинг интеграций и выбрать нужную интеграцию – Секретные ключи - Ключ

3) Body

Самый простой путь: Кампании – Список кампаний – Операции – «Выбираем нужную операцию» - кликаем «Посмотреть логи интеграций».
Копируем тело запроса, вставляем в Postman и меняем обязательные поля под наши. В моём примере – это email.

Если вы не знаете какие поля нужно обязательно передавать, то по пути: Кампании – Список кампаний – Операции – «Выбираем нужную операцию» - Посмотреть описание
В Описании запроса будет отмечена «Обязательность» того или иного поля.

Когда запрос готов – жмём «Send»

Если всё успешно – то получите ответ «Success» или 200 .

Больше про CRM-маркетинг и около него в канале: t.me/CindRoM_samozvanza