Postman

Коллекция Postman находится в процессе заполнения. Она содержит все запросы, но у некоторых может отсутствовать описание или предустановленные параметры.

Эта документация доступна в виде коллекции Postman.

Воспользуйтесь ссылкой ниже, чтобы открыть исходный код коллекции:

Настройка коллекции в Postman

  1. Если у вас нет рабочего пространства (Workspace) в Postman, создайте его.

    Создание рабочего пространства в Postman
  2. В рабочем пространстве нажмите кнопку импорта:

    Импорт коллекции Postman
  3. Импортируйте коллекцию одним из доступных способов:

    • Ссылка

    • Текст

    • Локальный файл

    В поле ввода введите ссылку на коллекцию:

    https://api.cpult.ru/_attachments/SAYMON%20REST%20API.postman_collection.json
    postman import new

    Скопируйте исходные данные коллекции. Вставьте текст коллекции в поле ввода:

    postman import new

    Перетащите файл с коллекцией в окно импорта или нажмите кнопку Select files и выберите файл с коллекцией в формате .json.

    Импорт коллекции в виде файла
  4. После импорта коллекции нажмите на папку коллекции, чтобы задать необходимые переменные:

    postman vars

Аутентификация

В этой коллекции используется Аутентификация по токену. Вы должны указать свой токен в переменной api-token.

Вы можете сгенерировать этот токен либо с помощью пользовательского интерфейса Центрального Пульта, либо с помощью запроса Создать токен аутентификации в самой импортированной коллекции.

Чтобы сгенерировать токен в Postman, выполните следующие действия:

  • Настройте переменные saymonHostname, username и password.

  • Откройте запрос SAYMON REST API/Authentication/Authentication Token/Create Authentication Token и нажмите кнопку Send, чтобы отправить запрос «Создать токен аутентификации».

  • Установите переменную коллекции api-token в токене аутентификации, возвращаемом в ответе. Токен должен быть записан без кавычек.