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

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

API швидкийстарт

Зателефонуйте Google Search та YouTube API безпосередньо над HTTP. Відправити запит і читати JSON відповідь; SDK обов'язковий.

  1. Ауттентицид

    Створіть обліковий запис, перевірте свою електронну пошту та створіть ключ з дозволом Google Search. Ви можете використовувати наявний ключ.

    Виконайте команду в терміналі та вставте ключ у запит із прихованим введенням. Пропустіть крок, якщо FLASHDATA_API_KEY вже задано.

    Задайте ключ
    # 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
  2. Виконайте пошук

    Оберіть клієнт і запустіть приклад в одному терміналі. Відправляється один POST запит на https://data.flashdata.dev/v1/queries/realtime і друк JSON. Аутентифікація з X-API-Key; відправити JSON з Content-Type: application/json.

    cURL 7.76+ · Bash на Linux, macOS або Git Bash. Паста і бігти.

    Пошук · Bash / cURL
    curl --fail-with-body --silent --show-error --max-time 70 \
      --request POST https://data.flashdata.dev/v1/queries/realtime \
      --header "X-API-Key: $FLASHDATA_API_KEY" \
      --header 'Content-Type: application/json' \
      --data '{
      "source": "google_search",
      "query": "battery recycling research",
      "params": {
        "num": 5
      }
    }'
  3. Перевірте результат

    Підтвердіть успіх HTTP і status: done. Читання назв джерела, посилань та фрагментів у results[].organic та заряду у usage.credits.

    За допомогою status: done є діє порожній результат.

    Приклад відповіді
    {
      "source": "google_search",
      "status": "done",
      "results": [
        {
          "organic": [
            {
              "title": "Battery recycling research",
              "link": "https://example.org/recycling",
              "snippet": "An example search excerpt."
            }
          ]
        }
      ],
      "usage": {
        "credits": 0.02
      }
    }
    status
    "done" підтверджує успішність запиту.
    results[0].organic[]
    Результати пошуку. Перевірити результати, які не можна, перш ніж його індексувати.
    title / link / snippet
    Заголовок джерела, URL та ЕКЗ.
    usage.credits
    Актуальні кредити, що стягуються за цей запит.

Заощаджуйте відгук про відбілювання

Для захоплення наступного призначеного запиту додайте ці параметри до команди cURL вище. Переглядайте файли перед тим, як видалити дані про недійсний запит.

cURL
--dump-header response-headers.txt --output result.json

Перевірити доступ і кредити

Ці запити GET читати ідентичність, баланс та ціноутворення без використання кредитних запитів. Очікуйте HTTP 200 і перевірте поля нижче, перш ніж подати платну роботу.

Ознайомитися з обліковими записами: https://api.flashdata.dev/v2. Запити даних: https://data.flashdata.dev/v1. Як використовувати X-API-Key; JSON POST також використовують Content-Type: application/json.

Безкоштовні перевірки · Bash
(
for endpoint in 'identity' 'balance' 'pricing?source=google_search&request_count=1'; do
  printf '\n%s\n' "$endpoint"
  curl --fail-with-body --silent --show-error --max-time 20 \
    --header "X-API-Key: $FLASHDATA_API_KEY" \
    --write-out '\nHTTP %{http_code}\n' \
    "https://api.flashdata.dev/v2/api-access/$endpoint" || exit
done
)
identity
Підтвердіть призначене accountId, access: "ready", обсяги, що містять "google_search", і будь-який expiresAt. accountType є "owned" для ключа власника або "temporary" для тестового ключа.
balance
Читати availableCredits. Всі ключі для даного облікового запису використовують однаковий баланс.
pricing
Для prices[0] підтвердіть джерело google_search і доступний true. Порівняйте estimatedCredits для requestCount: 1 з availableCredits. Ціни і баланси можуть змінюватися перед подачею.

Наступний крок

Якщо крок не зникає

Прочитайте відповідь, надана в терміналі. JavaScript і Python звіт HTTP помилки і Retry-After до stderr. Кожен приклад подає один раз; він не автоматично переробляє.

Відсутня або не підтримується опція
Перевірити необхідну версію в обраному прикладі. Використовуйте PowerShell 7, а не Windows PowerShell 5.1, або використовуйте Bash з cURL 7.76+. JavaScript не потребує 22+; Python потребує 3.10+. Встановіть відсутній робочий час з офіційної сторінки завантаження, перекрийте термінал, потім знову встановіть ключ.
Змішувач ключ / 401
Встановіть FLASHDATA_API_KEY в цьому процесі і перевірте стиль знову. Поставка повного активного ключа API, без префікса ведмедя. Якщо це було скасовано або було викликано, використовуйте поточний уповноважений достовірність; не вставте його в чат.
403
Перевірте identity.scopes для google_search і доступ до готовності. Запитати про відсутність дозволу власника; змінити джерело в запиті не надано доступу.
402
Повторно перевірте баланс і порівняйте його з поточною ціною. Власник може переглянути Billing. Вичерпаний пробний доступ слід прив’язати до облікового запису власника; створення нового пробного доступу не є відновленням.
400 / 422
Читати повернуті повідомлення про помилку. Перевірити точну кількість даних, метод POST, Content-Type та JSON. Використовуйте прямі котирування та нумерична params.num, потім виправте відхилений запит.
429
Зверніть увагу, що Retry-After, якщо присутні; в іншому випадку використовується обмежений зворотний зв'язок і зменшити опуклість. Не петля швидко, створити нові ключі або зареєструвати ще одну пробну версію для обходу ліміту.
HTTP 200 з недійсним статусом або помилкою
Прочитайте похибку в тілі і зберігайте будь-який запит або роботу ID. Не лікуйте тіло JSON як успішне завдання або автоматично відмініть його.
Зручні результати
У разі виконання статусу, автентифікації працювала. Зберігайте порожній результат або спробуйте більш широкий запит, як новий платний запит.
Час, з'єднання втрат, 5xxx або HTML замість JSON
А.А. POST може бути прийнята навіть якщо її відмова втратили. Перевірити History для оригінального запиту і зберегти будь-який повернутий IDs перед відмовою від перевитрат. Безкоштовна перевірка GET може бути перерозподілена. Підтвердіть URL використовує data.flashdata.dev, не відвідайте веб-сайт, і не відключити перевірку TLS.