This article assumes previous experience with APIs.
Ознакомьтесь со статьями «Таблицы», «Операторы» и «Машины», чтобы узнать, как настроить ключ API.
Используйте Tulip Connectors для тестирования API Tulip
Prior to r383, Service Accounts were called "API Tokens".
Ознакомьтесь с инструкциями по настройке коннектора и подключите его с помощью настроенной вами учетной записи службы API (см. эту статью о настройке учетной записи службы).
После настройки коннектора нажмите «Создать функцию». В этом примере мы рассмотрим, как получить записи из таблицы.
Сначала необходимо сформировать запрос с использованием методов GET, POST, PUT, HEAD, PATCH или DELETE, а затем указать конкретный URL-адрес, по которому вы хотите отправить запрос (подробнее о возможностях нашего API читайте здесь) .

If you are using a global Service Account, you need to specify the workspace. If your Service Account is workspaced scoped, it is optional.
https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/tables/(TableID)/records
Обязательно добавьте данные аутентификации (из самой учетной записи службы), заголовки запроса (при необходимости) и параметры запроса (либо в самом URL-адресе, либо в параметрах запроса — подробнее о настройке параметров запроса читайте здесь).
Кроме того, вы можете указать любые входные или выходные данные, которые функции коннектора могут потребоваться для обратной связи с приложением или автоматизацией.

Использование Postman для тестирования API Tulip
Ниже описано, как создать оператор. В данном примере для создания будет использоваться Postman.
Сначала добавьте конечную точку API в запрос POST.

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

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

В поле «Body» (Тело запроса) отформатируйте запрос так, чтобы он принимал объект JSON. Общий формат этого запроса выглядит следующим образом.
{"role": "operator","name": "string","badge_id": "string"}
Это будет выглядеть примерно так:

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

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

Вы перейдете на страницу, где можно протестировать API с помощью созданного ключа. Там же вы найдете документацию и примеры тел запросов для различных целей.
На этой странице также указан URL-адрес сервера, необходимый для настройки запросов к API из внешних систем. Чтобы ознакомиться с API, нажмите кнопку «Авторизовать».

Эта кнопка предоставит дополнительную информацию о настройке API для тестирования. Введите в поля следующие данные:
- Имя пользователя: API-ключ
- Пароль: секретный ключ
Нажмите «Авторизовать», после чего вы сможете приступить к тестированию некоторых типичных HTTP-запросов к таблицам.

Каждый из параметров на этой странице можно развернуть и протестировать. Каждый запрос предоставляет полезную информацию о соответствующих ответах.
На этой странице также представлена информация о схемах для некоторых компонентов Tulip. Например, для создания записи в таблице полезно знать правильный формат JSON для каждого столбца. Пример схемы для столбцов приведен ниже:

