İçeriğe geç
TR
API anahtarı al
Belgeleri incele

API başvurusu

Realtime ve async

Yanıtda sonuçları alın veya bir iş gönderin ve daha sonra alın. Uygulamanızın veya acentenizin iş için nasıl bekleyeceğini seçin.

Bu sayfada

Bir istek modu seçin

Google Search ve YouTube Data iki modu da destekler. YouTube Download için async, Batch veya Bulk gerekir; realtime desteklenmez. Realtime modundan async moduna geçerken kaynak parametreleri aynı kalır.

Mode ModeNe zaman kullanınNe aldığınızı
RealtimeMevcut etkileşimde bir arama sonucu gereklidir.Sonuç vücut aynı HTTP cevabı.
AsyncÇalışma, işlem bağlantılarından sonra devam etmeli veya medyayı indiriyorsunuz.Bir iş ID hemen; statü getir ve ayrı sonuçlar.
Yaşam döngüsü
Realtime  POST data.flashdata.dev/v1/queries/realtime → Sonuçlar
Async POST data.flashdata.dev/v1/queries → iş ID
          GET  api.flashdata.dev/v2/jobs/{id}         → statü
          GET  api.flashdata.dev/v2/jobs/{id}/results → Sonuçlar

Bir istek gönder

Set Set Set FLASHDATA_API_KEY Bir anahtara izin veren google_search. Gerçek zamanlı veya async seçin; her bir teslim bir faturalı arama yapar. Senaryoları, makbuzları ve sonuçları aynı yeni çalışma klasöründe tut.

Python örnekleri Python 3.10 + ve İstekleri kullanır. Her senaryo bağımsız olarak çalışır ve dosyaları daha önceki adımlardan okur. cURL alternatifi Bash, cURL 7.76 + ve jq'ye ihtiyaç duyar.

Python · bir kez yüklemek
python3 -m pip install requests

Realtime: Şimdi sonucu elde edin

POST /v1/queries/realtime, status: done ve bir sonuç dizisi döndürür. result.json'u okuyun; ankete gerek yok.

realtime.py olarak tasarruf edin ve python3 realtime.py çalıştırın.

realtime.py
import json
import os
from pathlib import Path

import requests

response = requests.post(
    "https://data.flashdata.dev/v1/queries/realtime",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
    timeout=120, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("result.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))

Async: Bir iş makbulunu kurtarmak

POST /v1/queries, arama sonuçları değil, bekleyen bir iş makbulunu döndürür. submission.json'u kurtarın ve aşağıdaki isteklere devam edin.

submit_async.py olarak tasarruf edin ve python3 submit_async.py çalıştırın.

submit_async.py
import json
import os
from pathlib import Path

import requests

response = requests.post(
    "https://data.flashdata.dev/v1/queries",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    json={"source": "google_search", "query": "battery recycling research", "params": {"num": 5}},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
result = response.json()
Path("submission.json").write_text(json.dumps(result, indent=2), encoding="utf-8")
print(json.dumps(result, indent=2))
Receipt alanları · kısaltılmış örnek
{
  "id": "job_EXAMPLE",
  "source": "google_search",
  "status": "pending"
}

Bir async işi kontrol edin

job.status ile ID'u submission.json'da kullanarak okuyun. Beklemek veya işlemek için, tekrar kontrol etmeden önce Retry-After gecikmesini bekleyin; Python yazdırır ve cURL bunu status-headers.txt'da kurtarır. Hiçbir ipucu iade edilmezse geri dönün. Başarılı bir durum isteği, işin tamamlanmadığı anlamına gelmez.

job.statusSonraki eylem
pending / processingBekle, sonra aynı işi ID'u tekrar kontrol edin.
completedKurtarılan sonucu izleyin.
failedjob.error'u okuyun. Yeni çalışmayı sunmadan önce nedeni düzeltin.

job_status.py olarak tasarruf edin ve python3 job_status.py çalıştırın.

job_status.py
import json
import os
from pathlib import Path

import requests

job_id = json.loads(Path("submission.json").read_text(encoding="utf-8"))["id"]
response = requests.get(
    f"https://api.flashdata.dev/v2/jobs/{job_id}",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
Path("job.json").write_text(json.dumps(response.json(), indent=2), encoding="utf-8")
print(json.dumps(response.json()["job"], indent=2))
print("Retry-After:", response.headers.get("Retry-After", "not provided"))

Erişim tarihi: The completed result

Bunu job.status tamamlandıktan sonra çalıştırın. Varsayılan sonuçlar cevabı 302: İmzalanmış bir depolamaya işaret ediyor URL. Aşağıdaki iki istek, API anahtarını FlashData'da tutar ve orijinal JSON'yu result.json'ya kurtar. YouTube Download için, bu JSON, depolamanıza teslim edilen medyayı anlatıyor; video veya ses dosyası değil.

job_result.py olarak tasarruf edin ve python3 job_result.py çalıştırın.

job_result.py
import json
import os
from pathlib import Path

import requests

receipt = json.loads(Path("submission.json").read_text(encoding="utf-8"))
job_id = receipt["id"]
response = requests.get(
    f"https://api.flashdata.dev/v2/jobs/{job_id}/results",
    headers={"X-API-Key": os.environ["FLASHDATA_API_KEY"]},
    timeout=30, allow_redirects=False,
)
response.raise_for_status()
if response.status_code != 302:
    raise RuntimeError(f"Expected a result redirect, got {response.status_code}")
url = response.headers["Location"]
if not url.startswith("https://"):
    raise ValueError("Expected an HTTPS storage URL")

# A separate request: no FlashData key is sent to storage.
result = requests.get(url, timeout=120)
result.raise_for_status()
data = result.json()  # Requests automatically decodes Content-Encoding: gzip.
Path("result.json").write_text(json.dumps(data, indent=2), encoding="utf-8")
print(json.dumps(data, indent=2))

gecikmeler ve başarısızlıklar

Durum durumuYapılacak işlem
Submission timed outBir POST zaten kabul edilebilir. Kurtarılmış makbuz ve hesap tarihini yeniden göndermeden önce kontrol edin; Tekrarlanan POST'ler yeni faturalı işler yaratabilir.
409 · result_not_readyKirliliği tutun. Başka bir iş yaratmaz.
422 · result_not_readyİş başarısız oldu. job.error'u yeniden denemeden önce okuyun.
429Honor Retry-After veya retry_after; bekleme kapasitesi dolduğunda teslim oranı azaltır.
410 · result_expiredMağazalı sonuçlar tamamlandıktan sonra 24 saatlerini sona erdirir. Kurtarılan kopyasını kullanın.