オペレーターAPIガイド

Prev Next

Operator API の設定方法について学ぶ

Advanced Content

This article assumes previous experience with APIs.

Tulipで開発されたアプリを実行するユーザーを設定するには、サイトにオペレーターを追加する必要があります。オペレーターの作成方法は2つあります:***「設定」**にある「ユーザー」ページ* Tulip APIを介して外部システムを使用する。

以下の手順では、Tulip API を使用してオペレーターを作成する方法を説明します。

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

Feature rename

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

Tulipインスタンスで、右上隅のプロフィールアイコンをクリックし、「設定」を選択します。

Configuring Your Tulip Account Settings_124925135

「Tulip API」を選択し、右上の「サービスアカウントを作成」ボタンをクリックします。

Create%20API%20token1

「作成」メニューで、APIトークンに名前を付け、「users:write」スコープを選択します。「作成」をクリックします。

Create API Token

Note

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

Operator API の使用

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

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

NOTE

If you are using a global API key, you need to specify the workspace. If your API key is workspaced scoped, it is optional.

https://(yourinstancenamehere).tulip.co/api/v3/w/(workspace)/users

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

「Headers」セクションで、「Auth Header」を追加します。

「Body」では、JSON オブジェクトを受け入れるようにリクエストを構成します。このリクエストの一般的な形式は以下の通りです。

{"role": "operator","name": "string","badge_id": "string"}

これにより、次のような表示になります:

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

リクエストが失敗した場合は、キーとシークレットが正しいか確認してください。特定のレスポンスコードの詳細については、「API の概要」を参照してください。


お探しの情報は見つかりましたか?

また、community.tulip.coにアクセスして質問を投稿したり、他のユーザーが同様の質問を投稿していないか確認することもできます!