Set up and use the Tulip API to interact with Tulip from other systems.
This article assumes previous experience with APIs.
Tulip interacts with many other system's APIs via Connectors. Using connectors, a Tulip app can initiate an HTTP or SQL query.
In other cases, you may want to allow an external system to query data that only exists within Tulip. It is possible to communicate with Tulip from external systems using the Tulip API. This article will walk through the set up and testing for the Tulip API.
The Tulip API is useful for integrating these external systems with Tulip in many ways. The API currently only works with Tulip Tables This might include updating a table record with new information, creating a table, or getting the count of records in a table.
Stations API functionality
Stations API can help you manage and onboard new stations quickly. The general functionality is to create, list, and modify stations, station groups, and interfaces(formerly known as display devices). Read more here.
For example, you can write a script that allows you to automatically send a link to set up a new interface every time you onboard a new user.
Walkthrough
Set up the Stations API
See this article to see how to set up an API Token.
If you have a Tulip API already set up, you may use that API Key and Secret
- In the Account Settings, select the API Tokens tab.
- Click Create API Token.
- Name your API Token.
- For Scopes, select
stations: readandstations: write:
Make sure to save the API Token information for the API Key, Secret, and Authorization Header.
- Click Save.
Use the Stations API
After you set up the Stations API, you can create a station.
This example uses Postman to perform the creation.
-
Add your API endpoint to the Post request.
-
Under Headers, add the Auth Header.
- In the Body, format the request to take in the JSON object. The generic format for this request is as follows:
When you form the request, include the workspace.
Example:
<your-instance-name>.tulip.co/api/stations/v1/w/1/stations
This example is hitting the stations endpoint. If you don’t have a workspace then you should set it as 1.
- Hit Send to run the request, and you will receive a 200 response to indicate success.
To verify, go to the Stations page, in the Shop Floor tab, and confirm the station was created.
