Lewati ke isi
ID
Dapatkan kunci API
Jelajahi dokumentasi

Mulai

Otomatiskan dengan FlashData CLI

Validasi permintaan, jalankan dari script dan baca hasil terpisah dan penerimaan kesalahan.

Di halaman ini

1. Pilih profil yang ada

Gunakan CLI terinstal, Bash dan jq. Hidup Windows, jalankan contoh shell dalam Git Bash. Jalan-jalan ini menggunakan profil penelitian terotentikasi; atur FLASHDATA_STATE_DIR ke direktori absolut di mana profil tersebut disimpan.

Gunakan OS yang sama dan direktori status pada setiap perintah. FLASHDATA_API_KEY overrides kunci disimpan; biarkan itu unset untuk menggunakan profil. CLI tidak memuat berkas .env.

Periksa akses yang tersimpan
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Lokasi keadaan baku

Gunakan --state-dir asli jika Anda memilih lokasi gubahan. auth status harus melaporkan data.accessVerified: true. Untuk penyebaran tanpa pengawasan, impor kunci pemilik melalui stdin dari toko rahasia.

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

2. Validasi permintaan dan harga

Simpan request.json, kemudian jalankan pemeriksaan gratis di direktori yang sama. Cetakan filter true hanya ketika harga sumber tersedia dan keseimbangan mencakup satu kueri. Berhenti di pintu keluar kosong. Cek harga tidak ada kredit cadangan.

request.json
{
  "source": "google_search",
  "query": "battery recycling research",
  "params": {
    "num": 5
  }
}
Bash + jq
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. Jalankan dan membaca tanda terima

Setelah pemeriksaan selesai, selamatkan run-search.sh dan jalankan Bash run-search.sh. Eksekusi pertama yang sukses menyerahkan satu pencarian. Setiap percobaan menyimpan berkasnya dalam direktori cli-run baru; run stabil ID memungkinkan CLI menggunakan kembali sukses awal untuk akun yang sama, profil dan direktori negara.

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"

Tahu berkas mana yang akan dibaca

Amplop CLI dan sumber respon berbeda dokumen JSON. Tanpa --output, sumber respon ada dalam data. Contoh ini menggunakan --output, jadi baca ruas sumber dari result.json yang disimpan.

BerkasBaca
receipt.jsonok, runId, cache, penggunaan dan jalur keluaran. Sebuah tanda terima cache melaporkan penggunaan asli, bukan biaya baru.
result.jsonsumber, status, hasil dan penggunaan. Untuk Google Search, baca results[].organic[]. Array kosong dapat berupa hasil pencarian yang valid.
error.jsonPada keluar nonzero, pemeriksaan error.code, error.httpStatus, error.retryAfter dan run/jobXQ IDs.
receipt.json Pameran ilustratif
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Reover tanpa pencarian lain

Periksa eksekusi tersimpan sebelum mencoba lagi. Dengan akses ke akun asal, ekspor eksekusi yang berhasil ke nama file yang belum ada. Penautan beralih dari akun uji coba ke akun pemilik; simpan hasil uji coba yang sudah diekspor dan gunakan ID baru untuk tugas baru milik pemilik. Perubahan permintaan dengan ID eksekusi yang sama akan ditolak; gunakan ID baru hanya jika memang ingin membuat tugas baru.

Inspeksi, lalu ekspor sukses yang disimpan
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

Tambahkan penjadwalan ketika skrip bekerja

Gunakan --recurring dengan akses pemilik terinstal, satu stabil ID per jadwal kejadian dan keadaan gigih. Sebuah percobaan tidak dapat menjalankan pekerjaan berulang. Host Anda memiliki jadwal; bendera hanya memeriksa akses. Gunakan lengkap rekuring-task runner untuk penangkaran penjadwalan penjadwalan terjadwal dan dijalankan ulang.

Opsional: penyimpanan unduh pribadi

Untuk download youtube --storage-config storage.json, simpan hanya objek penyimpanan ini sebagai storage.json dan mengganti placeholder lokal. Berkas harus privat dan dimiliki oleh pengguna eksekusi. Gunakan perintah ijin yang cocok sebelum menjalankan suatu unduh.

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

Panduan terkait