Коллекция Postman для Internal API ActivePlatform

Postman — популярный инструмент для тестирования и разработки API. Чтобы упростить интеграцию с Internal API ActivePlatform, рекомендуется использовать коллекцию Postman с полным набором методов и связанное окружение. Окружение содержит значения переменных, которые используются в методах, включая базовый URL и токен авторизации для доступа к сервису API.

Методы в коллекции снабжены кратким описанием используемых параметров (на англ.) а также примерами запросов и ответов.

В этой статье:

Установка коллекции и окружения

Чтобы установить коллекцию Postman с полным набором методов Internal API ActivePlatform и окружение:

1. Скачайте и распакуйте архив с файлами ActivePlatform Internal API [{version}].postman_collection.json и AP Internal Test [{version}].postman_environment.json, где {version} — версия ActivePlatform:

   Скачать

2. Откройте Postman.

3. В меню выберите File>Import. Отобразится окно импорта файлов.

4. Нажмите Choose Files и выберите скачанные JSON-файлы или сразу перетащите их в область Drop files here.

5. Дождитесь, когда Postman загрузит коллекцию и окружение выбранной версии ActivePlatform:

   • В левой панели на вкладке Collections отобразится коллекция ActivePlatform Internal API.

   • В правом верхнем углу в списке окружений станет доступно для выбора окружение AP Test.

Настройка переменных окружения

Выполните следующие настройки переменных окружения:

1. В переменной reseller_domain укажите доменное имя реселлера инсталляции ActivePlatform (например, https://test.activeplatform.com).

2. Чтобы получить access_token, вызовите метод Вход. Postman автоматически сохранит значение токена в переменной окружения.

3. Значения других переменных указывайте по мере необходимости.

   Установка значений переменных окружения в Postman

   Чтобы установить значение переменной окружения в Postman, необходимо:

   1. Откройте Postman.

   2. В правом верхнем углу окна Postman в списке выберите требуемое окружение.

   3. Нажмите . Отобразится список переменных окружения.

   4. Наведите указатель мыши на строку с требуемой переменной и нажать появившуюся кнопку .

   5. В столбце Current Value введите требуемое значение и нажмите Enter.