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

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

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

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

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

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

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

   Скачать

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

3. В меню выберите File>Import. Отобразится окно импорта файлов.
   
   
   
   
4. Нажмите Choose Files и выберите скачанные JSON-файлы или сразу перетащите их в область Drop files here.
5. Дождитесь, когда Postman загрузит коллекцию и окружение выбранной версии ActivePlatform:
   • В левой панели на вкладке Collections отобразится коллекция ActivePlatform Reseller API.
   • В правом верхнем углу в списке окружений станет доступно для выбора окружение AP Test.

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

Для получения доступа к сервису API, необходимо выполнить следующие настройки переменных окружения:

1. В переменной base_url укажите URL ActivePlatform (например, https://test.activeplatform.com).

   Адрес сервера для переменной base_url можно уточнить у команды технической поддержки или DevOps.

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

После получения доступа к сервису API значения других переменных для доступа к сущностям платформы можно указывать по мере необходимости.