Руководство по API для операторов

Prev Next

Узнайте, как настроить API для операторов

Advanced Content

This article assumes previous experience with APIs.

Добавление операторов на ваш сайт необходимо для создания списка пользователей, которые будут запускать приложения, разработанные в Tulip. Создать операторов можно двумя способами:* На странице «Пользователи», расположенной в разделе «Настройки»* С помощью внешней системы через API Tulip.

В приведенной ниже инструкции показано, как использовать API Tulip для создания операторов.

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

Feature rename

Prior to r383, Service Accounts were called "API Tokens".

В вашем экземпляре Tulip нажмите на значок профиля в правом верхнем углу и выберите «Настройки».

Configuring Your Tulip Account Settings_124925135

Выберите «API Tulip», затем нажмите кнопку «Создать служебную учетную запись » в правом верхнем углу.

Create%20API%20token1

В меню «Создание» присвойте токену API имя и выберите область действия users:write. Нажмите «Создать».

Create API Token

Note

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.

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

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

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

NOTE

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users

Затем в разделе «Авторизация» выберите «Базовая авторизация» и введите ключ API в поле «Имя пользователя», а секретный ключ API — в поле «Пароль».

В разделе «Заголовки» добавьте заголовок «Auth».

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

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

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

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

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


Нашли ли вы то, что искали?

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