Перейти к содержимому
RU
Ключ 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 без приставки Bearer. Если он истек или был отменен, используйте текущие авторизованные учетные данные; не вставляйте его в чат.
403
Проверьте identity.scopes для google_search и доступ к нему. Запросить у владельца недостающее разрешение; изменение источника в запросе не дает доступа.
402
Снова проверьте баланс и сравните его с текущей ценой. Владелец может открыть Billing. Когда пробный баланс исчерпан, нужно привязать доступ к аккаунту владельца; регистрация нового пробного доступа не является восстановлением.
400 / 422
Прочитайте возвращенное сообщение об ошибке. Проверьте точный хост данных, метод POST, имена полей Content-Type и JSON. Используйте прямые цитаты и цифру params.num, а затем исправьте отклоненный запрос.
429
Уважайте Retry-After, если он присутствует; в противном случае используйте ограниченную обратную связь и уменьшите параллелизм. Не зацикливайтесь быстро, создайте новые ключи или зарегистрируйте еще одну пробную версию, чтобы обойти лимит.
HTTP 200 с неудавшимся статусом или ошибкой
Прочитайте ошибку в теле и сохраните любой запрос или работу ID. Не относитесь к анализируемому телу JSON как к успешной задаче или автоматически отправляйте его повторно.
Пустые результаты
Если статус выполнен, аутентификация работает. Сохраните пустой результат или попробуйте более широкий запрос в качестве нового платного запроса.
Тайм-аут, потеря соединения, 5xx или HTML вместо JSON
POST может быть принят, даже если его ответ был потерян. Проверьте History для исходного запроса и сохраните любой возвращенный IDs, прежде чем принять решение о повторной отправке. Бесплатные чеки GET могут быть восстановлены. Подтвердите, что URL использует data.flashdata.dev, а не хост веб-сайта, и не отключайте проверку TLS.