オペレータAPIの使用方法

Operator API の使用

Operator APIの設定方法

サイトにオペレータを追加することは、Tulipで開発されたアプリを実行するユーザーを入力するために必要です。オペレーターは従来、アカウント所有者が設定内で作成していました。また、Tulip API経由で外部システムを使用してこれらのオペレータを作成することもできます。

オペレーターAPIトークンの追加

Tulipサイトで、右上のプロファイルに移動します。

このメニューから［設定］オプションを選択します。

設定]内で、[APIトークン]オプションを選択します。

このページの右側で、APIトークンの作成を選択します。

作成]でAPIトークンに名前を付け、Users:Writeスコープが選択されていることを確認し、[作成]をクリックします。

注: API Key、Secret、およびAuthorization HeaderのAPI Token情報を必ず保存してください。

オペレータAPIの使用

以下では、オペレータの作成方法を説明します。この例では、Postmanを使用して作成を実行します。

まず、APIエンドポイントをPostリクエストに追加します。

:::(Info) (注）グローバルAPIキーを使用している場合、ワークスペースを指定する必要があります。APIキーがワークスペース・スコープの場合は、省略可能です：

https://(yourinstancenamehere).tulip.co/api/v3/w/(ワークスペース)/tables/(TableID)/records

そして、AuthorizationでBasic Authを選択し、UsernameにAPI Keyを、PasswordにAPI Secretを入力する。

Headerの下にAuth Headerを追加する。

Bodyでは、JSONオブジェクトを取り込むリクエストをフォーマットする。このリクエストの一般的なフォーマットは以下の通り。

{ "role"："operator", "name"："string", "badge_id"："string" } となります。

このようになります：

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

リクエストが失敗した場合は、KeyとSecretが正しいことを確認してください。特定のレスポンスコードの詳細については、APIトークンのページにあるAPIドキュメントのセクションをご覧ください。

お探しのものは見つかりましたか？

community.tulip.coに質問を投稿したり、他の人が同じような質問に直面していないか確認することもできます！