Обзор документации
Начало работы
Создайте ключ для вашего приложения или агента. Храните его, проверяйте доступ и управляйте его жизненным циклом.
На этой странице
1. Создать ключ
- Войдите в свою проверенную учетную запись и откройте API Keys. Повторное использование авторизованного ключа, если он у вас уже есть.
- Назовите его для приложения и среды, выберите срок действия и выберите источники, которые ему нужны. Выберите Google Search для первого примера поиска.
- Создайте ключ и сохраните его ниже. Дайте независимым агентам и производственным приложениям отдельные ключи, чтобы вы могли отозвать их индивидуально.
2. Хранить ключ
Выберите способ запуска FlashData. Примеры API и SDK читают FLASHDATA_API_KEY; CLI может сохранить ключ в своем защищенном профиле. В производстве впрыскивайте учетные данные из вашего секретного магазина.
# Bash: paste the key into a hidden prompt, not into this command.
read -r -s -p "FlashData API key: " FLASHDATA_API_KEY
printf '\n'
export FLASHDATA_API_KEY# PowerShell 7: paste the key into a hidden prompt.
$flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString
$env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password
Remove-Variable flashdataSecureKeyВставьте ключ в скрытый запрос. Для именованного профиля добавьте имя --profile здесь и в более поздних командах. Ранее настроенный профиль требует входа в --replace для замены ключа.
flashdata auth login3. Проверить доступ
Запустите бесплатную проверку в том же терминале или в профиле CLI. Используйте вкладку, которая соответствует тому, как вы хранили ключ.
Повторно используйте FLASHDATA_API_KEY из предыдущей проверки в том же терминале.
(
: "${FLASHDATA_API_KEY:?Set FLASHDATA_API_KEY first}"
curl --fail-with-body --silent --show-error --max-time 20 \
--header "X-API-Key: $FLASHDATA_API_KEY" \
'https://api.flashdata.dev/v2/api-access/identity' || exit
printf '\n'
)Повторно используйте FLASHDATA_API_KEY из предыдущей проверки в том же терминале.
& {
$ErrorActionPreference = 'Stop'
if ([string]::IsNullOrWhiteSpace($env:FLASHDATA_API_KEY)) {
throw 'Set FLASHDATA_API_KEY first'
}
$flashdataHeaders = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
$flashdataBase = 'https://api.flashdata.dev/v2'
$flashdataUri = "$flashdataBase/api-access/identity"
Invoke-RestMethod -Uri $flashdataUri `
-Headers $flashdataHeaders -TimeoutSec 20 -MaximumRedirection 0 |
ConvertTo-Json -Depth 20
}Используйте сохраненный доступ CLI. Для именованного профиля добавьте имя --profile к каждой команде. Эти чтения не тратят кредиты на запросы.
flashdata auth statusПодтвердите аккаунт и источник
HTTP возвращает эти поля напрямую. С CLI JSON найдите их под data.identity.identity, а также потребуйте data.accessVerified: true.
| Проверить | Ожидаемый |
|---|---|
| accountId | Учетная запись, которой принадлежит эта рабочая нагрузка. |
| access | ready |
| scopes | Включает google_search для первого поиска. |
| recurringAllowed | true перед началом работы. |
Как работают разрешения источника
Ключ может использовать только предоставленные ему источники. Выбор продукта отделен от ценообразования: каждый ключ на счете расходуется из общего баланса, включая приобретенные кредиты. Ограниченный ключ не имеет собственного лимита расходов. Будущие продукты требуют явного разрешения.
Если ключ раскрыт
- Отзыв открытого ключа немедленно на соответствующей странице консоли ниже и остановка его запланированных абонентов.
- Создайте замену с необходимыми разрешениями, установите ее в секретном магазине каждого абонента и запустите бесплатную проверку выше.
- Просмотрите History и использование учетной записи для неожиданной активности. Удаление секрета из файла не отменяет его.
Вращайте ключ
- Создайте замену с требуемыми источниками и установите ее в целевую среду.
- Повторите бесплатную проверку выше, затем переключите приложение или планировщик. Обновление каждого предполагаемого звонка.
- Отмените старый ключ после того, как звонящие переключились. Секрет, обновленный на вашем ноутбуке, не обновляет развернутые службы.
flashdata auth login --replace
flashdata auth statusОтменить доступ
Остановите запланированные абоненты, отмените соответствующий ключ или соединение ниже, а затем повторите бесплатную проверку со старыми учетными данными. Оно должно быть отвергнуто. Выход из локальной сети не отменяет доступ к серверу.
| Тип доступа | Где отозвать |
|---|---|
| Обычный ключ API | API Keys |
| Заявленный ключ агента | Settings → Connected apps → Agent connections |
| MCP OAuthQ | Settings → Connected apps |