В прикрепленном файле статьи находится коллекция Postman. 

Что это?

Postman коллекция - это файл, созданный в приложении Postman, который содержит набор HTTP запросов, ответов и сопутствующей информации, связанной с тестированием API.

Коллекция в Postman включает в себя следующую информацию:

1. HTTP запросы: GET, POST, PUT, DELETE.
2. Параметры запросов: параметры пути, параметры запроса, тело запроса, заголовки запроса и другие параметры.
3. Ожидаемые ответы: коды ответов, тела ответов и заголовки ответов.
4. Переменные: значения переменных, которые могут использоваться в разных запросах, чтобы избежать повторений.
    

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

Подробнее о работе с коллекциями можно ознакомиться здесь.

Тестирование запросов в Postman

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

Вы можете протестировать запросы API с помощью коллекции в Postman. Для этого:

1) Откройте Postman

2) Скачайте коллекцию запросов из вложения в этой статье (внизу)

3) Загрузите файл в Postman — в меню Collections и нажмите на кнопку Import:

4) Импортируйте json файл
5) Готово, коллекция импортирована:

Настройка переменных

Чтобы начать работу с API, перейдите в вашей системе через "Управление" в раздел "Глобальные настройки", где во вкладке "Система" вы найдёте API ключ. Данный ключ используется как основной метод авторизации в системе и доступен только главному администратору системы!

Первая часть ключа (до двоеточия) - почта/логин. Вторая часть ключа (после двоеточия) - токен API. Перед отправкой запросов необходимо заполнить переменные. Для этого выберите коллекцию HelpDeskEddy API и перейдите в раздел Variables. 

Укажите в значении переменных свои данные: url, version (текущая версия по умолчанию 2), login и token:

Не забудьте сохранить изменения, после чего можно протестировать отправку запросов на практике. В случае корректных настроек вы получите ответ со статусом 200: