Dokumentation durchsuchen
Erste Schritte
Erstellen Sie einen Schlüssel für Ihre App oder Ihren Agenten. Speichern Sie es, überprüfen Sie den Zugriff und verwalten Sie seinen Lebenszyklus.
Auf dieser Seite
1. Erstellen Sie einen Schlüssel
- Melden Sie sich bei Ihrem verifizierten Konto an und öffnen Sie API Keys. Verwenden Sie einen autorisierten Schlüssel, wenn Sie bereits einen haben.
- Benennen Sie es für die App und die Umgebung, wählen Sie einen Ablauf und wählen Sie die benötigten Quellen aus. Wählen Sie Google Search für das erste Suchbeispiel.
- Erstellen Sie den Schlüssel und speichern Sie ihn unten. Geben Sie unabhängigen Agenten und Produktions-Apps separate Schlüssel, damit Sie sie einzeln widerrufen können.
2. Speichern Sie den Schlüssel
Wählen Sie, wie Sie FlashData ausführen möchten. API und SDK Beispiele lesen FLASHDATA_API_KEY; der CLI kann den Schlüssel in seinem geschützten Profil speichern. In der Produktion, injizieren Anmeldeinformationen aus Ihrem geheimen Speicher.
# 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 flashdataSecureKeyFügen Sie den Schlüssel in die versteckte Aufforderung ein. Für ein benanntes Profil, anhängen --profile NAME hier und in späteren Befehlen. Ein zuvor konfiguriertes Profil erfordert die Anmeldung --replace, um seinen Schlüssel zu ersetzen.
flashdata auth login3. Zugang prüfen
Führen Sie den kostenlosen Check im selben Terminal oder CLI-Profil aus. Verwenden Sie die Registerkarte, die mit dem Speicher des Schlüssels übereinstimmt.
Verwenden Sie FLASHDATA_API_KEY aus dem früheren Check im selben Terminal wieder.
(
: "${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'
)Verwenden Sie FLASHDATA_API_KEY aus dem früheren Check im selben Terminal wieder.
& {
$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
}Verwenden Sie Ihren gespeicherten CLI-Zugang. Für ein benanntes Profil, anhängen --profile NAME zu jedem Befehl. Diese Reads geben keine Abfrage-Credits aus.
flashdata auth statusBestätigen Sie das Konto und die Quelle
HTTP gibt diese Felder direkt zurück. Mit CLI JSON finden Sie sie unter data.identity.identity und benötigen auch data.accessVerified: true.
| Überprüfung | Erwartet |
|---|---|
| accountId | Das Konto, das diese Workload besitzt. |
| access | ready |
| scopes | Enthält google_search für die erste Suche. |
| recurringAllowed | true vor der geplanten Eigentümerarbeit. |
Wie Source-Berechtigungen funktionieren
Ein Schlüssel kann nur seine gewährten Quellen verwenden. Die Produktauswahl ist von der Preisgestaltung getrennt: Jeder Schlüssel auf dem Konto verbringt den geteilten Saldo, einschließlich der gekauften Credits. Ein eingeschränkter Schlüssel hat keine eigene Ausgabenobergrenze. Zukünftige Produkte erfordern eine ausdrückliche Genehmigung.
Wenn ein Schlüssel ausgesetzt ist
- Widerrufen Sie den ausgesetzten Schlüssel sofort auf der passenden Konsolenseite unten und stoppen Sie die geplanten Anrufer.
- Erstellen sie einen ersatz mit den erforderlichen berechtigungen, installieren sie ihn im geheimspeicher jedes anrufers und führen sie die kostenlose Überprüfung oben aus.
- Überprüfen Sie History und die Kontonutzung für unerwartete Aktivitäten. Das Entfernen eines Geheimnisses aus einer Datei widerruft es nicht.
Drehen Sie einen Schlüssel
- Erstellen Sie einen Ersatz mit den erforderlichen Quellen und installieren Sie ihn in der Zielumgebung.
- Wiederholen Sie die kostenlose Überprüfung oben und wechseln Sie dann die Anwendung oder den Zeitplan. Aktualisieren Sie jeden beabsichtigten Anrufer.
- Widerrufen Sie den alten Schlüssel, nachdem die Anrufer gewechselt haben. Ein auf Ihrem Laptop aktualisiertes Geheimnis aktualisiert keine bereitgestellten Dienste.
flashdata auth login --replace
flashdata auth statusZugang widerrufen
Stoppen sie geplante anrufer, widerrufen sie den passenden schlüssel oder die unten stehende verbindung und wiederholen sie dann die kostenlose Überprüfung mit dem alten anmeldenachweis. Er sollte abgelehnt werden. Durch das lokale Abmelden wird der Serverzugriff nicht widerrufen.
| Zugangsart | Wo zu widerrufen |
|---|---|
| Gewöhnlicher API Schlüssel | API Keys |
| Claimed Agent Key (Schlüssel des Bevollmächtigten) | Settings → Connected apps → Agent connections |
| MCP OAuth | Settings → Connected apps |