Przeglądaj dokumentację
Pierwsze kroki
Utwórz klucz dla aplikacji lub agenta. Przechowuj go, sprawdź dostęp i zarządzaj jego cyklem życia.
Na tej stronie
1. Utwórz klucz
- Zarejestruj się na zweryfikowanym koncie i otwórz API Keys. Ponownie użyj autoryzowanego klucza, jeśli już go masz.
- Nazwa aplikacji i środowiska, wybierz termin ważności i wybierz źródła, których potrzebuje. Wybierz Google Search dla pierwszego przykładu wyszukiwania.
- Utwórz klucz i zapisz go poniżej. Daj niezależnym agentom i aplikacji produkcyjnych oddzielne klucze, dzięki czemu można je anulować indywidualnie.
2. Przechowywać klucz
Wybierz sposób, w jaki uruchomisz FlashData. Przykłady API i SDK odczytują FLASHDATA_API_KEY; CLI może zapisać klucz w swoim chronionym profilu. W produkcji, wpisz referencje ze swojego tajnego sklepu.
# 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 flashdataSecureKeyWklej klucz na ukrytym poście. Dla profilu o nazwie, tutaj i w późniejszych poleceniach należy dołączyć nazwę --profile. Wcześniej skonfigurowany profil wymaga logowania --replace, aby zastąpić swój klucz.
flashdata auth login3. Weryfikacja dostępu
Uruchom darmowe sprawdzenie w tym samym terminalu lub profilu CLI. Użyj zakładki, która pasuje do sposobu przechowywania klucza.
Ponowne użycie FLASHDATA_API_KEY z wcześniejszego sprawdzenia w tym samym terminalu.
(
: "${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'
)Ponowne użycie FLASHDATA_API_KEY z wcześniejszego sprawdzenia w tym samym terminalu.
& {
$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
}Użyj zapisanego dostępu do CLI. Dla o nazwie profilu, przyłącz nazwę --profile do każdego polecenia. Te odczyty nie wydają kredytów zapytania.
flashdata auth statusPotwierdź konto i źródło
HTTP zwraca te pola bezpośrednio. Z CLI JSON, znaleźć je pod data.identity.identity, a także wymagają data.accessVerified: true.
| Sprawdź | Oczekiwane |
|---|---|
| accountId | Konto, które jest właścicielem tego obciążenia pracą. |
| access | ready |
| scopes | Zawiera google_search dla pierwszego wyszukiwania. |
| recurringAllowed | true przed planowaną pracą właściciela. |
Jak działają uprawnienia źródłowe
Klucz może korzystać tylko ze swoich źródeł. Wybór produktu jest odrębny od cen: każdy klucz na koncie wydaje ze wspólnego salda, w tym zakupionych kredytów. Ograniczony klucz nie ma własnego limitu wydatków. Przyszłe produkty wymagają wyraźnego zezwolenia.
Jeśli klucz jest narażony
- Otworzyć wyświetlony klucz natychmiast na stronie konsoli dopasowania poniżej, i zatrzymać jego zaplanowane dzwoniących.
- Utwórz zastępstwo z wymaganymi uprawnieniami, zainstaluj je w tajnym sklepie każdego rozmówcy i uruchom bezpłatną weryfikację powyżej.
- Przegląd History i wykorzystanie konta dla nieoczekiwanej aktywności. Usunięcie sekretu z akt nie unieważnia go.
Obróć klucz
- Utwórz zastępstwo z wymaganymi źródłami i zainstalować je w środowisku docelowym.
- Powtórzyć darmową weryfikację powyżej, a następnie przełączyć aplikację lub terminarz. Uaktualnij każdego zamierzonego rozmówcę.
- Odśwież stary klucz po podłączeniu słuchaczy. Tajemnica uaktualniona na laptopie nie aktualizuje usług wdrożonych.
flashdata auth login --replace
flashdata auth statusDostęp ponownie
Zaprzestanie połączeń planowych, cofnięcie pasującego klucza lub połączenia poniżej, a następnie powtórzenie bezpłatnej weryfikacji ze starym creditial. Należy je odrzucić. Wylogowanie się lokalnie nie unieważnia dostępu do serwera.
| Typ dostępu | Gdzie należy odwołać |
|---|---|
| Zwykły klucz API | API Keys |
| Zatwierdzony klucz agenta | Settings → Connected apps → Agent connections |
| MCP OAuth grant | Settings → Connected apps |