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

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

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

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

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

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

1. Скачать и распаковать архив с файлами ActivePlatform 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 API.
   • В правом верхнем углу в списке окружений станет доступно для выбора окружение AP Test.

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

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

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

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

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

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