Импорт и настройка коллекции API-методов в Postman

Инструкция поможет вам импортировать и настроить коллекцию API-методов для работы с Altcraft Platform через Postman. Следуя шагам ниже, вы сможете быстро загрузить API-методы, настроить переменные среды и начать отправлять тестовые запросы для взаимодействия с платформой.

Импорт коллекции

1. Сначала убедитесь, что у вас установлен Postman. Вы можете скачать его на официальном сайте.

2. Скачайте коллекцию API-методов на ваше устройство.

подсказка

Если загрузка файла не началась, кликните правой кнопкой мыши по ссылке и выберите "Сохранить ссылку как".

3. В Postman перейдите в раздел "Collections" и нажмите кнопку "Import":

4. Импортируйте файл с коллекцией через окно загрузки:

После завершения импорта все API-методы появятся в боковой панели:

5. Коллекция содержит переменные среды Postman. Перейдите в раздел "Variables", чтобы просмотреть список переменных.

6. В колонке "Initial value" записаны исходные значения для каждой переменной. Они выступают в качестве примера. Замените эти значения на актуальные для вашего аккаунта в колонке "Current value".

7. Сохраните изменения с помощью кнопки "Save" или Ctrl + S.

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

Обязательно сохраняйте изменения в списке переменных после их редактирования.

Список переменных коллекции

Переменная Postman	Описание
url	URL-адрес панели управления платформы Если вы работаете в облачном аккаунте Altcraft Platform, используйте ru.altkraft.com. При установке платформы на ваше оборудование (on-Premise) — используйте ваш собственный URL.
token	Токен платформы (создается в разделе "Настройки" => "Токены")
Основные объекты платформы
resource_id	Идентификатор ресурса
db_id	Идентификатор базы профилей
db_custom_field	Имя дополнительного поля в базе профилей Обратите внимание, во всех запросах коллекции используется дополнительное поле с типом "Целое число". Если вы работаете с другими типами полей, убедитесь, что подставляете значение в корректном формате.
stsegment_id	Идентификатор статического сегмента
dynsegment_id	Идентификатор динамического сегмента
segment_id	Идентификатор статического или динамического сегмента
suplist_id	Идентификатор стоп-списка
template_id	Идентификатор шаблона сообщения
campaign_id	Идентификатор кампании
workflow_id	Идентификатор сценария
pixel_id	Идентификатор пикселя
loyalty_id	Идентификатор программы лояльности
vsender_id	Идентификатор виртуального сендера
Системные параметры
profile_id	Идентификатор профиля
smid	Идентификатор отправки сообщения (можно найти в заголовке письма X-AKMTA-FSMID)
subscription_id	Идентификатор push-подписки профиля (push-токен)
rtoken	Токен ресурса (можно найти в окне редактирования ресурса на вкладке "Детали" — кнопка в правом верхнем углу)
launch_id	Внутренний идентификатор отправки, уникальный в рамках рассылки
Маркет
product_id	Дополнительный идентификатор продукта
sku_id	Дополнительный идентификатор SKU
order_external_id	Дополнительный идентификатор заказа (строка)
order_internal_id	Идентификатор заказа (число)
line_id	Дополнительный идентификатор позиции заказа
market_endpoint	Дополнительный идентификатор точки контакта
market_region	Дополнительный идентификатор региона
market_category	Дополнительный идентификатор категории продукта или SKU
market_currency	Идентификатор валюты