Перейти до вмісту
UK
Отримати ключ API
Переглянути документацію

Початок роботи

Автоматизація з FlashData CLI

Вкажіть запит, запустіть його з скрипта та ознайомтеся окремий результат та отримання помилок.

На цій сторінці

1. Виберіть існуючий профіль

Використовуйте встановлену CLI, Bash і jq. На Windows запустіть приклади оболонки в Git Bash. Цей прохід використовує автентифікований профіль досліджень; встановити FLASHDATA_STATE_DIR до абсолютного каталогу, де зберігається цей профіль.

Використовуйте той самий OS користувача і державного каталогу на кожному командному рядку. FLASHDATA_API_KEY перенадає збережений ключ; залиште його неналаштувати для використання профілю. CLI не завантажує .env файлів.

Перевірити збережений доступ
: "${FLASHDATA_STATE_DIR:?Set the existing absolute state directory}"
flashdata auth status --profile research --state-dir "$FLASHDATA_STATE_DIR" --json

Місцезнаходження за замовчуванням

Використовуйте свій оригінальний --state-dir, якщо ви вибрали користувацьке розташування. auth status повинен повідомити data.accessVerified: true. Для ненав'язаного розгортання імпорт ключа власника через stdin з його секретного магазину.

OSДовідник
Windows%APPDATA%/FlashData
macOS~/Library/Application Support/FlashData
Linux$XDG_STATE_HOME/flashdata або ~ /.local/state/flashdata

2. Вкажіть запит і ціну

Заощаджуйте request.json, потім запустіть безкоштовні перевірки в одному каталозі. Фільтр друкує true тільки при наявності початкової ціни, а баланс охоплює одну запит. Стоп на незероній виході. Вартість перевірки не залишає за собою кредитів.

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. Запуск та читання квитанції

Після проходження перевірок, зберегти run-search.sh і запустити bash run-search.sh. Перша успішна реалізація подає один пошук. Кожна спроба зберігає свої файли в новому каталозі cli-run; стабільний запуск ID дозволяє CLI повторно використовувати для одного облікового запису, профілю та державного каталогу.

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"

Знайте, що файл для читання

Конверт CLI і відповідь джерела відрізняється документами JSON. Без --output, вихідний відповідь в дані. Цей приклад використовує --output, щоб читати джерела поля з збережених result.json.

ГоловнаЧитати далі
receipt.jsonok, runId, кешування, використання та вихідний шлях. Приблизний чек повідомляє про оригінальне використання, а не новий заряд.
result.jsonджерело, статус, результати та використання. Для Google Search читайте results[].organic[]. Порожній масив може бути дійсним результатом пошуку.
error.jsonПро вихід незеро, огляд error.code, error.httpStatus, error.retryAfter і будь-який run/job IDs.
receipt.json · ілюстративний різак
{
  "schemaVersion": 1,
  "ok": true,
  "runId": "cli-research-001",
  "cached": false,
  "data": {
    "output": "cli-run.EXAMPLE/result.json"
  },
  "usage": {
    "credits": 0.02
  }
}

Відновлення без іншого пошуку

Оглянути збережений курс до переробки. З доступом до оригінального облікового запису, експортувати успішний запуск на ім'я файлу, який ще не існує. Переключення за допомогою тестового облікового запису власнику; зберігайте раніше експортовані результати випробувань і використовуйте новий IDs для нових завдань власника. Змінений запит за однаковим виконанням ID відхилений; використовувати новий ID тільки для навмисного нового завдання.

Інспекція, потім експорт збережених успіхів
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

Додавання розкладу при роботі скрипта

Використовуйте --recurring з встановленим доступом власника, одну стабільну ID за заплановану появу та стійкий стан. Не може запускати повторну роботу. Ваше хост володіє графіком; прапор тільки перевіряє доступ. Використовуйте повний рецидивно-тасковий бігун для регулярного обслуговування та перезавантаження.

Додатково: приватна сховища завантаження

Для YouTube завантажити --storage-config storage.json, зберегти тільки цей об'єкт зберігання, як storage.json і замінити локально. Файл повинен бути приватним і володіючи користувачем, що виконує його роботу. Використовуйте команду дозволу на відповідність перед запуском завантаження.

storage.json · S3
{
  "storage_type": "s3",
  "storage_url": "YOUR_BUCKET",
  "access_key": "YOUR_ACCESS_KEY",
  "secret_key": "YOUR_SECRET_KEY",
  "region": "us-east-1"
}
Обмеження доступу до файлів
chmod 600 storage.json

Схожі посібники