← Cloudflare Flagship / flagship
API-токены
Flagship поддерживает два вида API-токенов. Оба используют один и тот же Создание API-токена поток. Разница в том, к какому ресурсу применяется политика разрешений.
| Тип токена | Ресурс | К чему у него есть доступ |
|---|---|---|
| Для всей учетной записи | Entire Account | Все приложения Flagship в аккаунте |
| На уровне приложения | Указанные приложения Flagship | Только выбранные вами приложения Flagship |
Используйте токен уровня аккаунта, если доверенный серверный процесс должен иметь доступ ко всем приложениям Flagship. Используйте токен с областью действия на конкретное приложение, если процесс должен работать только с выбранными приложениями, например с CI или backend-сервисом для одного продукта.
Оба типа токенов поддерживают Чтение, Write, а также Оценка. Названия изменяются в зависимости от ресурса:
| Доступ | Для всей учетной записи | На уровне приложения |
|---|---|---|
| Оценка флагов | Flagship Evaluate | Flagship App Evaluate |
| Чтение конфигурации флага | Flagship Read | Flagship App Read |
| Управление флагами | Flagship Write | Flagship App Write |
Вы должны создать приложение Flagship прежде чем вы сможете создать токен, привязанный к приложению. Дашборд может отображать только уже существующие приложения.
Создание токена на уровне аккаунта
Создание токена Flagship на уровне аккаунта ↗ чтобы открыть страницу Account API tokens. Затем создайте пользовательский токен и оставьте ресурс равным Entire Account.
Чтобы создать токен самостоятельно:
-
На панели управления Cloudflare перейдите к разделу Токены API аккаунта страницу.
Перейдите в Токены API аккаунта ↗Вы также можете создать пользовательский токен из My Profile ↗ > API-токены.
-
Выберите Create Token.
-
Выберите Create Custom Token > Начало работы.
-
Введите название токена.
-
В разделе Политики разрешений, оставьте в раскрывающемся списке ресурсов значение Entire Account.
-
Найдите Flagship и выберите Flagship Evaluate, Flagship Read, или Flagship Write.
-
(Необязательно) Ограничьте токен с помощью Фильтрация по IP-адресу или TTL.
-
Выберите Токен проверки > Create Token.
-
Скопируйте секрет токена и сохраните его в надёжном месте.
Создание токена на уровне приложения
Создание токена Flagship на уровне приложения ↗ чтобы открыть форму токена с Указанные приложения Flagship и Flagship App Evaluate уже выбран. Затем выберите приложение и создайте токен.
Чтобы создать токен самостоятельно:
-
На панели управления Cloudflare перейдите к разделу Токены API аккаунта страницу.
Перейдите в Токены API аккаунта ↗Вы также можете создать пользовательский токен из My Profile ↗ > API-токены.
-
Выберите Create Token.
-
Выберите Create Custom Token > Начало работы.
-
Введите название токена, описывающее, где вы будете его использовать, например
checkout-service-ci. -
В разделе Политики разрешений, откройте раскрывающийся список ресурсов (по умолчанию используется Entire Account) и выберите Указанные приложения Flagship.
-
В Выберите приложения Flagship, выберите приложение или приложения, к которым должен иметь доступ этот токен.
-
В разделе Developer Platform, выберите Flagship App разрешение:
Сценарий использования Разрешение Оценка флагов в выбранных приложениях Flagship App Evaluate Чтение конфигурации флага для выбранных приложений Flagship App Read Управление флагами в выбранных приложениях Flagship App Write -
(Необязательно) Ограничьте токен с помощью Фильтрация по IP-адресу или TTL.
-
Выберите Токен проверки > Create Token.
-
Скопируйте секрет токена и сохраните его в надёжном месте.
Используйте токен
Передайте токен в OpenFeature SDK как authToken (TypeScript) или аналогичный параметр в 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.
Следующие шаги
- Настройте TypeScript Server SDK вне Workers.
- Ограничьте использование токена с помощью Фильтрация по IP или TTL.