Настройте и используйте API Tulip для взаимодействия с Tulip из других систем.
This article assumes previous experience with APIs.
Tulip взаимодействует с API многих других систем через коннекторы. С помощью коннекторов приложение Tulip может инициировать HTTP-запрос или запрос SQL.
В других случаях может потребоваться разрешить внешней системе запрашивать данные, которые существуют только в Tulip. С помощью API Tulip можно осуществлять взаимодействие с Tulip из внешних систем. В этой статье будет подробно описан процесс настройки и тестирования API Tulip.
API Tulip полезен для интеграции этих внешних систем с Tulip многими способами. В настоящее время API работает только с таблицами Tulip. Это может включать обновление записи в таблице новой информацией, создание таблицы или получение количества записей в таблице.
Функциональные возможности API «Станции»
API «Станции» поможет вам быстро управлять станциями и подключать новые. Основные функции включают создание, просмотр списка и изменение станций, групп станций и интерфейсов (ранее называвшихся устройствами отображения). Подробнее читайте здесь.
Например, вы можете написать скрипт, который будет автоматически отправлять ссылку для настройки нового интерфейса каждый раз при подключении нового пользователя.
Пошаговое руководство
Prior to r383, Service Accounts were called "API Tokens".
Настройка API Stations
Ознакомьтесь с этой статьёй, чтобы узнать, как настроить служебную учётную запись.
If you have a Service Account already set up, you may use that API Key and Secret
- В настройках учётной записи выберите вкладку «Tulip API ».
- Нажмите «Создать служебную учетную запись».
- Присвойте имя учетной записи службы.
- В поле «Области доступа» выберите
«stations: read» и«stations: write»:

Make sure to save the Service Account information for the API Key, Secret, and Authorization Header.
- Нажмите «Сохранить».
Использование API «Станции»
После настройки API Stations вы можете создать станцию. В этом примере для создания используется Postman.
- Добавьте конечную точку API в запрос POST.

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

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

При формировании запроса укажите рабочую область. Пример:<your-instance-name>.tulip.co/api/stations/v1/w/1/stations В этом примере выполняется запрос к конечной точке stations. Если у вас нет рабочей области, вам следует установить значение 1.
- Нажмите «Отправить», чтобы запустить запрос, и вы получите ответ с кодом 200, подтверждающий успешное выполнение.
Чтобы проверить результат, перейдите на страницу «Станции» на вкладке «Производственный цех » и убедитесь, что станция была создана.

