Перейти к основному содержимому

Как получить идентификаторы профиля, папки и рабочего пространства в Postman

Запросы API Indigo X часто требуют идентификаторы профиля, папки или рабочего пространства для выполнения операций. Это руководство поможет вам пошагово получить эти идентификаторы с помощью Postman, будь то для одного профиля или для автоматизации с несколькими идентификаторами. Следуйте этим инструкциям, чтобы начать!

Предварительные требования​

Перед началом убедитесь, что у вас есть:

  • Аккаунт Indigo X с доступом к API.
  • Действующий API-токен для аутентификации.
  • Установленный и настроенный Postman.
  • Доступ к коллекции Indigo X API в Postman.
Совет

Если вы еще не настроили коллекцию Indigo X API в Postman, импортируйте ее из документации Indigo X API, чтобы упростить рабочий процесс.

Получение идентификаторов профилей​

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

Вариант 1: Получение идентификатора одного профиля вручную​

Чтобы найти идентификатор отдельного профиля:

  1. Откройте панель управления Indigo X.
  2. Щелкните на нужный профиль в списке профилей.
  3. Перейдите на вкладку Краткая сводка справа.
  4. Найдите Идентификатор профиля, отображаемый в сводке.

Идентификатор одного профиля

Примечание

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

Вариант 2: Получение нескольких идентификаторов профилей с использованием конечной точки POST Profile Search​

Чтобы программно получить несколько идентификаторов профилей:

  1. В Postman перейдите в коллекцию Indigo X API.

  2. Откройте папку Управление профилями.

  3. Выберите запрос POST Profile Search.

  4. На вкладке Авторизация:

    • Установите Тип на Bearer Token.
    • Введите ваш API-токен в поле Token.

  5. На вкладке Тело:

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

  7. Просмотрите ответ на вкладке Тело, который возвращает JSON-объект, содержащий список идентификаторов профилей.

Ответ POST Profile Search

Получение идентификаторов папок​

Идентификаторы папок требуются для операций, связанных с папками Indigo X, таких как организация профилей. Вот как их получить:

  1. В Postman перейдите в коллекцию Indigo X API.
  2. Откройте папку Управление доступом к профилям.
  3. Выберите запрос GET Workspace Folders.
  4. На вкладке Авторизация:
    • Установите Тип на Bearer Token.
    • Введите ваш API-токен в поле Token.
  5. Нажмите Отправить.
  6. На вкладке Тело ответа вы увидите JSON-список всех папок в вашем рабочем пространстве, включая их идентификаторы папок.

Ответ GET Workspace Folders

Информация

Каждая папка в ответе включает folder_id, name и другие метаданные. При необходимости отфильтруйте JSON, чтобы извлечь только идентификаторы.

Получение идентификаторов рабочих пространств​

Идентификаторы рабочих пространств необходимы для операций в разных рабочих пространствах, с которыми вы связаны. Следуйте этим шагам:

  1. В Postman перейдите в коллекцию Indigo X API.
  2. Откройте папку Управление доступом к профилям.
  3. Выберите запрос GET User Workspaces.
  4. На вкладке Авторизация:
    • Установите Тип на Bearer Token.
    • Введите ваш API-токен в поле Token.
  5. Нажмите Отправить.
  6. На вкладке Тело ответа вы увидите JSON-список всех идентификаторов рабочих пространств, в которые вы добавлены.

Ответ GET User Workspaces

Предупреждение

Убедитесь, что ваш API-токен имеет достаточные права для доступа к данным рабочего пространства. Если ответ пуст, проверьте токен или свяжитесь с администратором рабочего пространства.

Устранение распространенных проблем​

  • Недействительный токен: Дважды проверьте ваш API-токен в поле Bearer Token. Сгенерируйте новый токен, если он истек.
  • Пустой ответ: Убедитесь, что ваше рабочее пространство содержит профили или папки. Проверьте, имеет ли токен необходимые разрешения.
  • Ограничения по скорости: Если вы достигли лимитов API, подождите и попробуйте снова или обновите ваш план Indigo X.
Информация

Для получения подробных кодов ошибок и решений обратитесь к документации Indigo X API.