Использование API оператора

Использование API оператора

Как настроить API оператора

Добавление операторов на ваш сайт необходимо для того, чтобы пополнить список пользователей, которые будут работать с приложениями, разработанными в Tulip. Операторы традиционно создаются в Настройках владельцами аккаунтов. Вы также можете создать этих операторов с помощью внешней системы через Tulip API.

Добавление API-токена оператора

На сайте Tulip перейдите к своему профилю в правом верхнем углу.

{height="" width="250"}.

В этом меню выберите пункт Настройки.

В разделе Настройки выберите опцию API Tokens.

В правой части страницы выберите пункт Создать API-токен.

В окне "Создание" задайте имя API-токену и убедитесь, что для него выбрана область действия Users:Write, после чего нажмите кнопку "Создать".

Примечание: Обязательно сохраните информацию о API-токене для ключа API, секрета и заголовка авторизации.

Использование API оператора

Далее будет рассмотрено, как создать оператор. В данном случае для создания оператора будет использован Postman.

Сначала добавьте конечную точку API в запрос Post.

{height="" width="450"}.

Затем в разделе Authorization выберите Basic Auth и введите API Key в качестве имени пользователя, а API Secret - в качестве пароля.

В разделе Headers добавьте заголовок Auth.

В поле Body отформатируйте запрос, чтобы принять объект JSON. Общий формат этого запроса выглядит следующим образом.

{ "role": "operator", "name": "string", "badge_id": "string" }

Это будет выглядеть примерно так:

{height="" width="550"}.

Нажмите кнопку send, чтобы выполнить запрос, и получите ответ 201, свидетельствующий об успехе. Для проверки можно проверить список пользователей в Настройках и убедиться, что пользователь был успешно создан.

Если запрос не прошел, убедитесь в правильности ключа и секрета. Более подробную информацию о конкретных кодах ответов можно найти в разделе "Документация по API" на странице "Токены API".

Вы нашли то, что искали?

Вы также можете зайти на community.tulip.co, чтобы задать свой вопрос или узнать, сталкивались ли другие с подобным вопросом!