Использование Postman с ГдеМои API¶

Что такое Postman?¶

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

Установка Postman¶

Чтобы загрузить последнюю версию приложения Postman, перейдите на страницу загрузки и нажмите «Скачать» для вашей платформы. Следуйте инструкциям по установке для вашей операционной системы.

Настройка Postman¶

1. Откройте Postman: После установки запустите приложение Postman.
2. Создайте аккаунт: Зарегистрируйтесь, если у вас ещё нет аккаунта Postman. Это позволит сохранять работу и синхронизировать её между устройствами, а также указывать некоторые параметры в качестве переменных.

Ваш первый запрос¶

Клиент API в Postman упрощает отправку запросов и гарантирует правильное форматирование параметров. Это особенно удобно при работе со сложными или объёмными запросами.

Шаги для выполнения первого запроса¶

1. Выберите метод запроса:

Каждый API-запрос использует HTTP-метод. Наиболее часто используемые методы для ГдеМои API — это GET и POST. Упрощенно, метод GET извлекает данные, а POST отправляет новые данные.

1. Введите базовый URL с ресурсом и вызовом:

Базовый URL (Base URL):

• Для сервера ГдеМои — https://my.gdemoi.ru/api-v2/
• Для сервера D3 — https://api-d3.gdemoi.ru/v2/

• Для сервера D4 — https://api-d4.gdemoi.ru/v2/

• Нажмите кнопку Params:

Для примера будем использовать запрос user/auth. Заполните поля — ключ (имя параметра из документации) и значение. Для запроса user/auth требуется два параметра — login и password.

После ввода имени параметра оно автоматически добавляется к строке запроса, как и значения с дополнительными параметрами.

1. Нажмите Отправить:

При запросе user/auth с правильными логином и паролем будет получен хэш, который нужно скопировать и использовать для последующих запросов. Вы увидите ответ сервера, уже структурированный для удобства чтения.

Управление параметрами¶

Если у запроса много параметров, вы можете легко включать и отключать их. Так вы можете проверять результаты с включенными и выключенными опциональными параметрами.

История запросов¶

Postman сохраняет историю запросов в верхней части интерфейса (вкладках), а при сохранении вызова в своей коллекции - в левой части. Вы можете вернуться к предыдущим запросам и повторно выполнить их двойным щелчком — они откроются в новой вкладке.

Примеры в документации¶

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

Импорт примеров cURL в Postman¶

Вы также можете импортировать примеры cURL из документации в Postman. Скопируйте пример, откройте импорт в Postman, выберите Raw Text, вставьте код и сохраните.