Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

Erste Schritte

Mit der FlashData CLI automatisieren

Validieren Sie eine Anforderung, führen Sie sie aus einem Skript aus und lesen Sie separate Ergebnis- und Fehlerbelege.

Auf dieser Seite

1. Wählen Sie das vorhandene Profil aus

Verwenden Sie die installierten CLI, Bash und jq. Führen Sie auf Windows die Shell-Beispiele in Git Bash aus. Dieser Durchlauf verwendet ein authentifiziertes Forschungsprofil; Setzen Sie FLASHDATA_STATE_DIR auf das absolute Verzeichnis, in dem dieses Profil gespeichert ist.

Verwenden Sie bei jedem Befehl den gleichen OS-Benutzer und das gleiche Zustandsverzeichnis. FLASHDATA_API_KEY überschreibt den gespeicherten Schlüssel; lassen Sie ihn ungesetzt, um das Profil zu verwenden. CLI lädt keine .env-Dateien.

Sicherer Zugriff
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Standard-Standorte

Verwenden Sie Ihren ursprünglichen --state-dir, wenn Sie einen benutzerdefinierten Standort gewählt haben. auth status sollte data.accessVerified: true melden. Für eine unbeaufsichtigte Bereitstellung importieren Sie den Besitzerschlüssel über stdin aus seinem Secret Store.

OSVerzeichnis
Windows%APPDATA%/FlashData
macOS~/Library/Application Support/FlashData
Linux$XDG_STATE_HOME/flashdata oder ~/.local/state/flashdata

2. Validierung der Anfrage und des Preises

Speichern Sie request.json und führen Sie dann die kostenlosen Schecks im selben Verzeichnis aus. Der Filter druckt true nur, wenn ein Quellpreis verfügbar ist und der Saldo eine Abfrage abdeckt. Stoppen Sie bei einem Nicht-Null-Ausgang. Eine Preisprüfung reserviert keine Credits.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq · keine bezahlte Einreichung
set -euo pipefail
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata account balance --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --json --non-interactive > balance.json
flashdata query --input request.json --dry-run --run-id cli-research-001 \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --json --non-interactive > preflight.json
jq -e --slurpfile balance balance.json '
  .ok and .data.dryRun and .data.estimateAvailable
  and ($balance[0].ok == true)
  and any(.data.estimate.prices[]?;
    .source == "google_search" and .available == true
    and (.estimatedCredits | type == "number")
    and ($balance[0].data.availableCredits | type == "number")
    and .estimatedCredits <= $balance[0].data.availableCredits)
' preflight.json

3. Führen und lesen Sie die Quittung

Nachdem die Prüfungen bestanden haben, speichern Sie run-search.sh und führen Sie bash run-search.sh aus. Die erste erfolgreiche Ausführung reicht eine Suche ein. Jeder Versuch speichert seine Dateien in einem neuen cli-run-Verzeichnis; der stabile Ablauf ID ermöglicht es dem CLI, einen früheren Erfolg für dasselbe Konto, Profil und Zustandsverzeichnis wiederzuverwenden.

run-search.sh
#!/usr/bin/env bash
set -euo pipefail
umask 077
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
dir=$(mktemp -d "cli-run.XXXXXX")
if ! flashdata query --input request.json --run-id cli-research-001 \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" \
  --output "$dir/result.json" --timeout 2m --json --non-interactive \
  > "$dir/receipt.json" 2> "$dir/error.json"; then
  cat "$dir/error.json" >&2
  printf 'Inspect saved run cli-research-001; receipts: %s\n' "$dir" >&2
  exit 1
fi
jq -e '.schemaVersion == 1 and .ok == true' "$dir/receipt.json" >/dev/null
jq -e '.status == "done" and .source == "google_search"' "$dir/result.json" >/dev/null
jq -r '.results[]?.organic[]? | [.title, .link] | @tsv' "$dir/result.json"
jq '{runId, cached, usage}' "$dir/receipt.json"
printf 'Files: %s\n' "$dir"

Wissen, welche Datei zu lesen ist

Der CLI-Umschlag und die Quellantwort sind unterschiedliche JSON-Dokumente. Ohne --output ist die Quellantwort in Daten. Dieses Beispiel verwendet --output, also lesen Sie Quellfelder aus dem gespeicherten result.json.

DateiLesen
receipt.jsonok, runId, zwischengespeichert, Nutzung und Ausgabepfad. Eine zwischengespeicherte Quittung meldet die ursprüngliche Nutzung, keine neue Gebühr.
result.jsonQuelle, Status, Ergebnisse und Nutzung. Für Google Search lesen Sie results[].organic[]. Ein leeres Array kann ein gültiges Suchergebnis sein.
error.jsonÜberprüfen Sie bei einer Nicht-Null-Ausfahrt error.code, error.httpStatus, error.retryAfter und alle run/job IDs.
receipt.json · illustrativer Auszug
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Wiederherstellen ohne weitere Suche

Überprüfen Sie den gespeicherten Lauf, bevor Sie erneut versuchen. Exportieren Sie mit Zugriff auf das ursprüngliche Konto einen erfolgreichen Lauf in einen Dateinamen, der noch nicht existiert. Anfordern von Wechseln vom Testkonto zum Eigentümer; zuvor exportierte Testergebnisse aufbewahren und neue IDs für neue Aufgaben des Eigentümers verwenden. Eine geänderte Anforderung unter demselben Ablauf ID wird abgelehnt; Verwenden Sie eine neue ID nur für eine absichtliche neue Aufgabe.

Inspizieren, dann exportieren Sie einen gespeicherten Erfolg
flashdata runs show cli-research-001 --profile research \
  --state-dir "$FLASHDATA_STATE_DIR" --json
flashdata runs show cli-research-001 --result --output recovered.json \
  --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Hinzufügen von Scheduling, wenn das Skript funktioniert

Verwenden Sie --recurring mit installiertem Besitzerzugriff, einem stabilen ID pro geplantem Ereignis und persistentem Zustand. Ein Prozess kann keine wiederkehrende Arbeit ausführen. Ihr Gastgeber besitzt den Zeitplan; Das Flag überprüft nur den Zugriff. Verwenden Sie den kompletten Repeating-Task-Läufer für die planmäßige Bearbeitung und Neustarts.

Optional: Private Download Storage

Speichern Sie für den YouTube-Download von --storage-config storage.json nur dieses Speicherobjekt als storage.json und ersetzen Sie Platzhalter lokal. Die Datei muss privat und im Besitz des ausführenden Benutzers sein. Verwenden Sie den Matching-Berechtigungsbefehl, bevor Sie einen Download ausführen.

storage.json · S3
{
  "storage_type": "s3",
  "storage_url": "YOUR_BUCKET",
  "access_key": "YOUR_ACCESS_KEY",
  "secret_key": "YOUR_SECRET_KEY",
  "region": "us-east-1"
}
Dateizugriff einschränken
chmod 600 storage.json

Ähnliche Leitfäden