Ga naar de inhoud
NL
API-sleutel ophalen
Documentatie bekijken

Aan de slag

Automatiseren met de FlashData CLI

Valideer een verzoek, voer het uit vanaf een script en lees aparte resultaat- en foutbonnen.

Op deze pagina

1. Selecteer het bestaande profiel

Gebruik de CLI, Bash en jq. Op Windows, voer de shell voorbeelden in Git Bash uit. Deze walkthrough maakt gebruik van een geauthentiseerd onderzoeksprofiel; stel FLASHDATA_STATE_DIR in op de absolute directory waar dat profiel wordt opgeslagen.

Gebruik dezelfde OS gebruiker en state directory op elk commando. FLASHDATA_API_KEY overschrijft de opgeslagen sleutel; laat deze uit om het profiel te gebruiken. De CLI laadt geen .env-bestanden.

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

Standaard statuslocaties

Gebruik je originele --state-dir als je een aangepaste locatie hebt gekozen. auth status moet data.accessVerified: true rapporteren. Voor een onbeheerde implementatie importeert u de sleutel van de eigenaar via stdin vanuit de geheime winkel.

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

2. Valideren van de aanvraag en prijs

Sla request.json op en voer vervolgens de gratis controles in dezelfde map uit. Het filter drukt true alleen af wanneer er een bronprijs beschikbaar is en het saldo betrekking heeft op één query. Stop bij een non-zero uitgang. Een prijscontrole reserveert geen credits.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq · geen betaalde indiening
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. Rennen en het ontvangstbewijs lezen

Na de controle pas, sla run-search.sh en voer bash run-search.sh. De eerste succesvolle uitvoering legt één zoekopdracht voor. Elke poging slaat zijn bestanden op in een nieuwe cli-run directory; de stabiele run ID laat de CLI opnieuw een eerder succes voor dezelfde account, profiel en state directory.

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"

Weet welk bestand gelezen moet worden

De CLI-envelop en de bronrespons zijn verschillende JSON-documenten. Zonder --output is de bronrespons in data. Dit voorbeeld gebruikt --output, dus lees bronvelden van de opgeslagen result.json.

BestandGelezen
receipt.jsonOK, runId, cache, gebruik en het uitvoerpad. Een cached bon meldt het oorspronkelijke gebruik, geen nieuwe lading.
result.jsonbron, status, resultaten en gebruik. Lees voor Google Search results[].organic[]. Een lege array kan een geldig zoekresultaat zijn.
error.jsonBij niet-nul uitgang, inspectie error.code, error.httpStatus, error.retryAfter en alle run/job IDs.
receipt.json · illustratief uittreksel
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Herstellen zonder een andere zoekopdracht

Controleer de opgeslagen run voordat u het opnieuw probeert. Met toegang tot het oorspronkelijke account, exporteer een succesvolle run naar een bestandsnaam die nog niet bestaat. Het claimen van switches van de trial account aan de eigenaar; houden eerder geëxporteerde trial resultaten en gebruik nieuwe IDs voor nieuwe eigenaar taken. Een gewijzigd verzoek onder dezelfde run ID wordt afgewezen; gebruik een nieuwe ID alleen voor een opzettelijke nieuwe taak.

Inspecteren en vervolgens een opgeslagen succes exporteren
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

Plannen toevoegen wanneer het script werkt

Gebruik --recurring met geïnstalleerde eigenaar toegang, een stabiele ID per geplande gebeurtenis en persistente toestand. Een proef kan geen terugkerend werk uitvoeren. Uw gastheer is eigenaar van het schema; de vlag controleert alleen toegang. Gebruik de volledige recurrente-taskrunner voor geplande-date behandeling en herstart.

Facultatief: privé-downloadopslag

Voor youtube downloaden --storage-config storage.json, bewaar alleen dit opslagobject als storage.json en vervang plaatshouders lokaal. Het bestand moet privé zijn en eigendom zijn van de uitvoerende gebruiker. Gebruik het bijpassende machtigingscommando voordat u een download uitvoert.

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

Gerelateerde gidsen