Обзор документации
Начало работы
Звоните в Google Search и YouTube API напрямую через HTTP. Отправьте один запрос и прочитайте ответ JSON; SDK не требуется.
аутентифицировать
Создайте учетную запись, проверьте свою электронную почту и создайте ключ с разрешения 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Задайте ключ# PowerShell 7: paste the key into a hidden prompt. $flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString $env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password Remove-Variable flashdataSecureKeyВыполните поиск
Выберите клиента и запустите пример в том же терминале. Каждый из них отправляет один запрос 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 / cURLcurl --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 } }'PowerShell 7+ · Вставьте эту команду PowerShell.
Поиск: PowerShell$flashdataRequest = '{"source":"google_search","query":"battery recycling research","params":{"num":5}}' $flashdataSearch = @{ Uri = 'https://data.flashdata.dev/v1/queries/realtime' Method = 'Post' Headers = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY } ContentType = 'application/json' Body = $flashdataRequest TimeoutSec = 70 MaximumRedirection = 0 SkipHttpErrorCheck = $true ErrorAction = 'Stop' } $flashdataResponse = Invoke-WebRequest @flashdataSearch $flashdataResponse.Content if ($flashdataResponse.StatusCode -ge 400) { throw "HTTP $($flashdataResponse.StatusCode). Inspect the response above before retrying." }Node.js 22+ · Сохраните как search.mjs и запустите локально или на своем сервере. Использует встроенный fetch; без установки npm.
search.mjsconst key = process.env.FLASHDATA_API_KEY; if (!key) throw new Error("Set FLASHDATA_API_KEY in this terminal."); let response; try { response = await fetch("https://data.flashdata.dev/v1/queries/realtime", { method: "POST", redirect: "error", signal: AbortSignal.timeout(70000), headers: { "X-API-Key": key, "Content-Type": "application/json" }, body: JSON.stringify({"source":"google_search","query":"battery recycling research","params":{"num":5}}), }); } catch { throw new Error("Request did not complete. Check History before resubmitting."); } const body = await response.text(); console.log(body); // Print the full response before checking its status. if (!response.ok) { const retryAfter = response.headers.get("retry-after"); throw new Error("HTTP " + response.status + ". See the response above." + (retryAfter ? " Retry-After: " + retryAfter : "")); } let result; try { result = JSON.parse(body); } catch { throw new Error("Expected JSON. Inspect the response above and the API URL."); } if (!result || result.error === true || result.status !== "done" || !Array.isArray(result.results)) { throw new Error("Query did not succeed. Inspect status and error in the response above."); }Бег: JavaScriptnode search.mjsPython 3.10+ · Сохранить как search.py. Использует только стандартную библиотеку, без установки pip. Используйте python3 или py-3, если это ваша команда Python.
search.pyimport json import os import urllib.error import urllib.request key = os.environ.get("FLASHDATA_API_KEY") if not key: raise SystemExit("Set FLASHDATA_API_KEY in this terminal.") # Do not forward the API key to a redirect destination. class NoRedirect(urllib.request.HTTPRedirectHandler): def redirect_request(self, req, fp, code, msg, headers, newurl): return None request = urllib.request.Request( "https://data.flashdata.dev/v1/queries/realtime", data=json.dumps({"source":"google_search","query":"battery recycling research","params":{"num":5}}).encode("utf-8"), headers={"X-API-Key": key, "Content-Type": "application/json"}, method="POST", ) try: with urllib.request.build_opener(NoRedirect).open(request, timeout=70) as response: body = response.read().decode("utf-8") except urllib.error.HTTPError as error: print(error.read().decode("utf-8", errors="replace")) retry_after = error.headers.get("Retry-After") raise SystemExit("HTTP " + str(error.code) + ". See the response above." + (" Retry-After: " + retry_after if retry_after else "")) except (urllib.error.URLError, TimeoutError): raise SystemExit("Request did not complete. Check History before resubmitting.") print(body) # The run command saves this full response to result.json. try: result = json.loads(body) except json.JSONDecodeError: raise SystemExit("Expected JSON. Inspect the response above and the API URL.") if (not isinstance(result, dict) or result.get("error") is True or result.get("status") != "done" or not isinstance(result.get("results"), list)): raise SystemExit("Query did not succeed. Inspect status and error in the response above.")Бег: Pythonpython -X utf8 search.pyПроверьте результат
Подтвердите успех 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 выше. Проверяйте файлы, прежде чем принять решение о повторном запросе.
--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.
(
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
)try {
foreach ($flashdataPath in @('identity', 'balance', 'pricing?source=google_search&request_count=1')) {
Write-Host $flashdataPath
$flashdataRead = @{
Uri = "https://api.flashdata.dev/v2/api-access/$flashdataPath"
Headers = @{ 'X-API-Key' = $env:FLASHDATA_API_KEY }
TimeoutSec = 20
MaximumRedirection = 0
ErrorAction = 'Stop'
}
Invoke-RestMethod @flashdataRead | ConvertTo-Json -Depth 20
}
} catch {
throw
}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.