Как использовать API оператора

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

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

:::(Info) (ПРИМЕЧАНИЕ) Расширенная статья: Предполагает предыдущий опыт работы с API. Нажмите здесь, чтобы просмотреть документацию по API операторов. :::

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

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

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

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

В разделе "Настройки" выберите пункт "Токены API".

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

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

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

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

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

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

:::(Info) (ПРИМЕЧАНИЕ) Если вы используете глобальный ключ API, вам необходимо указать рабочее пространство. Если ваш API-ключ относится к рабочему пространству, это необязательно:

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records.

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

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

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

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

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

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

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

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

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