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

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

  1. Откройте Postman
  2. Скачайте коллекцию запросов
  3. Загрузите файл в Postman — в меню Collections и нажмите на кнопку Import
  4. Нажмите кнопку Import
  5. Готово, коллекция импортирована.

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

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

Выберите коллекцию Plazius API в списке и перейдите в раздел Variables. Укажите в значении переменных свои данные: ApiKey, password и rkObjectId.

В самих запросах запросах менять ничего не нужно.

Другие переменные заполняются автоматически при выполнении запросов.

Запрос Подтверждение заказа требует в Body запроса наличия значения кода для ключа fingerprint.

Для удобства использования коллекции значение кода записывается в переменную fingerprint_code после выполнения запроса Предрасчет заказа и передается в виде переменной в запрос Подтверждение заказа.

 Авторизация

Чтобы выполнять запросы, необходимо сначала авторизоваться. Для этого: 

  1. Откройте папку Авторизация и отправьте запрос Получение токена. 
  2. Готово, если вы получили ответ 200, то авторизация прошла успешно. Postman автоматически заполнит переменную Bearer для выполнения будущих запросов.

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

Для серверной интеграции:

  • Время жизни — 15 минут
  • Обновлять с помощью запроса Получение токена
  • Обновлять не чаще одного раза в 10 минут.

Для клиентской интеграции:

  • Время жизни — 3 часа
  • Обновлять с помощью запроса Получение токена
  • Обновлять не чаще одного раза в 2 часа и только перед реальными запросами от клиента, а не превентивно в фоне.

Подробнее читайте в статьях Авторизация для серверной интеграции и Авторизация для клиентской интеграции.