Коллекция Postman на вашем компьютере#

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

Установка: Postman и импорт коллекции
Конфигурирование: настройка переменных среды
Тестирование: использование методов API

Установка#

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

Приложение Postman
Коллекция Green-API - MAX Postman Collection (клонируйте репозиторий или скачайте пакет в виде ZIP-файла)

После установки и запуска Postman, нажмите Import и выберите два JSON-файла collection.json и environment.json из пакета коллекции Postman на GitHub.

После импорта вы увидите элемент Green API RU Max (v3) в разделе Collections и сможете выбрать пункт GREEN-API Developer в качестве Environment.

Конфигурирование#

Настраиваемая среда Postman фактически представляет собой набор пар "ключ-значение". Вы можете создавать стандартные переменные, которые затем будут использоваться в разных запросах. Подробнее о переменных среды Postman.

Заранее настроенная среда GREEN-API Developer содержит полный набор переменных, на которые ссылается коллекция. Некоторые из этих переменных следует отредактировать и заменить собственными значениями. Чтобы открыть диалог редактирования, нажмите маленькую кнопку с изображением глаза рядом с раскрывающимся списком среды и выберите Edit.

Задайте значения четырех переменных apiUrl, mediaUrl, idInstanceи apiTokenInstance, которые были получены на этапе Перед началом работы.

Тестирование#

Теперь вы можете выбрать любой метод API в коллекции и приступать к отправке запросов. Все методы для удобства приведены в том же порядке, в каком они рассматриваются в Документации API. Вы можете вносить в эти методы любые изменения, чтобы упростить их тестирование и обработку ответов.