Skip to content

非公式 / UnofficialCloudflare, Inc. 非提携。アカウント情報は入力しないでください。Not affiliated with Cloudflare, Inc. Do not enter Cloudflare credentials here.Official docsこのサイトについてプライバシー

API トークン

最終更新 Markdown で表示Agent セットアップ

Flagship は 2 種類の API トークンに対応しています。どちらも同じ API トークンを作成する 手順を使います。違いは、権限ポリシーが適用されるリソースです。

トークンの種類 リソース アクセスできる範囲
アカウント全体 Entire Account アカウント内のすべての Flagship アプリ
アプリスコープ Specified Flagship apps 選んだ Flagship アプリだけ

信頼できるサーバーサイドのワークフローが、すべての Flagship アプリにアクセスする必要があるときは、アカウント全体のトークンを使います。選んだアプリだけに触れてほしいときは、アプリスコープのトークンを使います。たとえば、1 つの製品向けの CI やバックエンドサービスです。

どちらのトークンも Read、Write、Evaluate に対応しています。名前はリソースに応じて変わります。

アクセス アカウント全体 アプリスコープ
フラグを評価する Flagship Evaluate Flagship App Evaluate
フラグ設定を読み取る Flagship Read Flagship App Read
フラグを管理する Flagship Write Flagship App Write

アプリスコープのトークンを作成する前に、Flagship アプリを作成 する必要があります。ダッシュボードには、すでに存在するアプリだけが一覧表示されます。

アカウント全体のトークンを作成する

アカウント全体の Flagship トークンを作成する ↗ と、Account API tokens ページが開きます。カスタムトークンを作成し、リソースは Entire Account のままにします。

自分でトークンを作成する手順は次のとおりです。

  1. Cloudflare ダッシュボードで Account API tokens ページに移動します。

    公式ダッシュボードで Account API tokens を開く ↗

    My Profile ↗ > API Tokens からユーザートークンを作成することもできます。

  2. Create Token を選択します。

  3. Create Custom Token > Get started を選択します。

  4. トークン名を入力します。

  5. Permission policies で、リソースのドロップダウンは Entire Account のままにします。

  6. Flagship を検索し、Flagship Evaluate、Flagship Read、または Flagship Write を選択します。

  7. (任意)IP アドレスフィルターまたは TTL でトークンを制限します。

  8. Review token > Create Token を選択します。

  9. トークンシークレットをコピーし、安全に保管します。

アプリスコープのトークンを作成する

アプリスコープの Flagship トークンを作成する ↗ と、Specified Flagship apps と Flagship App Evaluate があらかじめ選ばれたトークン作成画面が開きます。アプリを選び、トークンを作成します。

自分でトークンを作成する手順は次のとおりです。

  1. Cloudflare ダッシュボードで Account API tokens ページに移動します。

    公式ダッシュボードで Account API tokens を開く ↗

    My Profile ↗ > API Tokens からユーザートークンを作成することもできます。

  2. Create Token を選択します。

  3. Create Custom Token > Get started を選択します。

  4. 使う場所が分かるトークン名を入力します。例: checkout-service-ci。

  5. Permission policies で、リソースのドロップダウン(デフォルトは Entire Account)を開き、Specified Flagship apps を選択します。

  6. Select Flagship apps で、このトークンがアクセスするアプリを選びます。

  7. Developer Platform で Flagship App 権限を選びます。

    用途 権限
    選んだアプリでフラグを評価する Flagship App Evaluate
    選んだアプリのフラグ設定を読み取る Flagship App Read
    選んだアプリでフラグを管理する Flagship App Write
  8. (任意)IP アドレスフィルターまたは TTL でトークンを制限します。

  9. Review token > Create Token を選択します。

  10. トークンシークレットをコピーし、安全に保管します。

トークンを使う

トークンは OpenFeature SDK に、TypeScript では authToken として渡します。Python と Go では、同等のオプションを使います。

import { OpenFeature } from "@openfeature/server-sdk";
import { FlagshipServerProvider } from "@cloudflare/flagship/server";

await OpenFeature.setProviderAndWait(
	new FlagshipServerProvider({
		appId: "<APP_ID>",
		accountId: "<ACCOUNT_ID>",
		authToken: "<APP_SCOPED_API_TOKEN>",
	}),
);

<APP_ID> と <ACCOUNT_ID> は、トークンのスコープ対象のアプリとアカウントに置き換えます。別のアプリを評価しようとすると、アプリスコープのトークンは拒否されます。

Cloudflare Worker 内では、バインディング を優先してください。バインディングは自動で認証するため、API トークンは不要です。

次のステップ

役に立ちましたか?