Переглянути документацію
Початок роботи
Створіть ключ для вашого додатка або агента. Зберігати його, перевірити доступ і керувати життєвим циклом.
На цій сторінці
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 NAME тут і в пізніх командах. Для заміни ключа потрібен логін --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 access. Для названого профілю, Додаток --profile NAME до кожного команди. Ці дані не витрачають на запити.
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Відновити доступ
Стоп запланованих дзвоників, відкликаючи ключ або підключення нижче, після чого повторіть перевірку безкоштовного з старим обліковим записом. Слід відхилити. Відправлення локально не відкликає доступ до сервера.
| Тип доступу | Де відкликати |
|---|---|
| Ordinary API ключ | API Keys |
| ключ Claimed агента | Settings → Connected apps → Agent connections |
| MCP OAuth грант | Settings → Connected apps |