This article assumes previous experience with APIs.
APIキーの設定方法については、「テーブル」、「オペレーター」、「マシン」の各記事をご参照ください。
Tulip Connectors を使用して Tulip の API をテストする
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 を使用した Tulip API のテスト
以下では、オペレーターの作成方法について説明します。この例では、Postmanを使用して作成を行います。
まず、PostリクエストにAPIエンドポイントを追加します。

次に、「Authorization」で「Basic Auth」を選択し、ユーザー名にAPIキー、パスワードにAPIシークレットを入力します。

「Headers」セクションで、「Auth」ヘッダーを追加します。

「Body」では、JSONオブジェクトを受け入れる形式でリクエストを構成します。このリクエストの一般的な形式は以下の通りです。
{"role": "operator","name": "string","badge_id": "string"}
これにより、次のような表示になります:

「送信」をクリックしてリクエストを実行すると、成功を示す 201 レスポンスが返されます。確認するには、「設定」の「ユーザー」リストを確認し、ユーザーが正常に作成されたことを確認してください。

リクエストが失敗した場合は、キーとシークレットが正しいか必ず確認してください。具体的なレスポンスコードの詳細については、Tulip API ページの「API ドキュメント」セクションをご覧ください。
APIドキュメントを使用したTulip APIのテスト
ワークスペースまたはアカウント設定で、Tulip API に移動します。そこから、「サービスアカウントの作成」オプションの横にある「詳細」をクリックしてください。

これにより、作成したキーを使用してAPIをテストできるページに移動します。また、このページにはドキュメントや、さまざまな用途のリクエスト本文の例も掲載されています。
このページには、外部システムからAPIリクエストを設定するために必要なサーバーURLも記載されています。APIに慣れるために、「Authorize」ボタンをクリックしてください。

このボタンをクリックすると、テスト用のAPI設定に関する詳細情報が表示されます。各フィールドに以下を入力してください:
- ユーザー名:APIキー
- パスワード:シークレット
「Authorize」をクリックすると、テーブルに対する一般的なHTTPリクエストのテストを開始できます。

このページの各オプションは展開してテストすることができます。各リクエストには、対応するレスポンスに関する有用な情報が記載されています。
このページには、Tulipのいくつかのコンポーネントに関するスキーマ情報も掲載されています。たとえば、テーブルレコードを作成する際には、各列に適したJSONのフォーマットを知っておくと便利です。列のスキーマ例を以下に示します:

