Stations APIガイド

Prev Next

Tulip API を設定・使用することで、他のシステムから Tulip と連携できます。

Advanced Content

This article assumes previous experience with APIs.

Tulipは、コネクタを介して他の多くのシステムのAPIと連携します。コネクタを使用することで、TulipアプリからHTTPやSQLクエリを実行できます。

また、Tulip内にのみ存在するデータを外部システムから照会できるようにしたい場合もあるでしょう。Tulip APIを使用すれば、外部システムからTulipと通信することが可能です。この記事では、Tulip APIの設定とテストの手順を解説します。

Tulip APIは、こうした外部システムとTulipをさまざまな方法で統合するのに役立ちます。現在、このAPIはTulipテーブルでのみ機能します。これには、テーブルのレコードを新しい情報で更新したり、テーブルを作成したり、テーブル内のレコード数を取得したりすることが含まれます。

Stations APIの機能

Stations API を使用すると、新しいステーションを迅速に管理・オンボーディングできます。主な機能として、ステーション、ステーショングループ、およびインターフェース(旧称:ディスプレイデバイス)の作成、一覧表示、変更があります。詳細はこちらをご覧ください。

例えば、新しいユーザーを登録するたびに、新しいインターフェースを設定するためのリンクを自動的に送信するスクリプトを作成することができます。

操作手順

Feature rename

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

Stations API の設定

サービスアカウントの設定方法については、こちらの記事をご覧ください。

NOTE

If you have a Service Account already set up, you may use that API Key and Secret

  1. 「アカウント設定」で、「Tulip API」タブを選択します。
  2. [サービスアカウントの作成] をクリックします。
  3. サービスアカウントに名前を付けます。
  4. 「スコープ」では、「stations: read」および「stations: write」を選択します:

Stations API 1

NOTE

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

  1. 「保存」をクリックします。

Stations API の使用

Stations API の設定が完了したら、ステーションを作成できます。この例では、Postman を使用して作成を行います。

  1. POSTリクエストにAPIエンドポイントを追加します。Stations API 2
  2. [Headers] の下で、Auth ヘッダーを追加します。

Stations API 3

  1. 「Body」で、JSONオブジェクトを受け入れる形式にリクエストを構成します。このリクエストの一般的な形式は次のとおりです:

Stations API 4

リクエストを作成する際は、ワークスペースを含めてください。例:<your-instance-name>.tulip.co/api/stations/v1/w/1/stations この例では、stationsエンドポイントにアクセスしています。ワークスペースがない場合は、1に設定してください。

  1. **[送信]**をクリックしてリクエストを実行すると、成功を示す 200 のレスポンスが返されます。

確認するには、「Stations」ページの「Shop Floor」タブに移動し、ステーションが作成されたことを確認してください。

Stations API 5