ข้ามไปยังเนื้อหา
TH
รับคีย์ API
เรียกดูเอกสาร

เอกสารอ้างอิง API

Realtime และ async

รับผลลัพธ์ในคำตอบทันที หรือส่งงานแล้วรับผลภายหลัง เลือกวิธีรอผลที่เหมาะกับแอปหรือเอเจนต์

ในหน้านี้

เลือกโหมดร้องขอ

Google Search ถึง YouTube Data รองรับทั้งสองโหมด YouTube Download ต้องการเอซิงค์ Batch หรือ Bulk.; ไม่ สนับสนุน เวลา จริง ๆ. ตัวแปรแหล่งยังคงเดิมเมื่อเปลี่ยนจากเวลาจริงเป็น aync

โหมดใช้เมื่อสิ่งใดที่ท่านได้รับ
Realtimeต้องการผลลัพธ์การค้นหาในการโต้ตอบในปัจจุบันร่างที่มีผลในการตอบสนอง HTTP แบบเดียวกัน
Asyncงานควรจะทําต่อไป หลังจากโพรเซสของคุณยุติการทํางาน หรือคุณกําลังดาวน์โหลดสื่ออยู่งาน ID ทันที เรียกสถานะและผลแยก
ขอรถชูชีพ
Realtime  POST data.flashdata.dev/v1/queries/realtime ○ ผล
Async     POST data.flashdata.dev/v1/queries          ○ งาน ID
          GET  api.flashdata.dev/v2/jobs/{id}         ○ สถานะ
          GET  api.flashdata.dev/v2/jobs/{id}/results ○ ผล

ส่งคําขอมา

ตั้งค่า FLASHDATA_API_KEY กุญแจที่อนุญาตให้ใช้ google_search. เลือกเวลาจริง หรือ asinc; การส่งแต่ละรายการใช้การค้นหาแบบเดียวที่สามารถเรียกดูได้ เก็บสคริปต์, ใบเสร็จ และผลลัพธ์ไว้ในโฟลเดอร์ที่ทํางานใหม่เดียวกัน

Python ตัวอย่างที่ใช้ Python 3.10+ และร้องขอ แต่ละสคริปต์ทํางานอย่างอิสระ และทําการอ่านแฟ้มจากขั้นตอนก่อนหน้า เดอะ cURL ทางเลือกที่ต้องการ Bash, cURL 7.76+ และ jq.

Python การติดตั้ง AH หนึ่งครั้ง
python3 -m pip install requests

Realtime: รับผลตอนนี้

POST /v1/queries/realtime กลับค่า status: done และผลที่ได้คือ อ่าน result.json; ไม่จําเป็นต้องใช้ผลสํารวจ

บันทึกเป็น realtime.py และเรียก python3 realtime.py.

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: บันทึกใบเสร็จค่างาน

POST /v1/queries คืนใบเสร็จค่างานที่ค้างคา ไม่ใช่ผลการค้นหา บันทึก submission.json และทําต่อไปกับสถานะที่ต้องการด้านล่างนี้

บันทึกเป็น submit_async.py และเรียก python3 submit_async.py.

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))
ช่องข้อมูล receept example
{
  "id": "job_EXAMPLE",
  "source": "google_search",
  "status": "pending"
}

ตรวจสอบงาน Asinc

อ่าน job.status ใช้ ID ใน submission.json. สําหรับระหว่างหรือการประมวลผลรอ Retry-After หน่วงเวลาก่อนที่จะตรวจสอบอีกครั้ง Python ลายนิ้วมือมันและ cURL บันทึกไว้ใน status-headers.txt. ใช้ย้อนกลับหากไม่มีการส่งคําใบ้กลับ การร้องขอสถานะที่ประสบความสําเร็จ ไม่ได้หมายความว่างานนั้นเสร็จสมบูรณ์แล้ว

job.statusการกระทําถัดไป
pending / processingเดี๋ยว เช็คงานเดิมที่ ID อีกครั้ง
completedรับผลที่บันทึกไว้
failedอ่าน job.error. แก้ไขต้นเหตุก่อนที่จะส่งงานใหม่

บันทึกเป็น job_status.py และเรียก python3 job_status.py.

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"))

รับผลที่เสร็จสมบูรณ์แล้ว

ประมวลผลหลังจาก job.status เสร็จสมบูรณ์แล้ว การตอบสนองปริยายของผลคือ 302ที่อยู่ของที่เก็บของที่ลงนาม URL. สองคําขอที่ด้านล่างเก็บของคุณ API กุญแจบน FlashData และบันทึกต้นฉบับ JSON ถึง result.json. สําหรับ YouTube Downloadนี่... JSON อธิบายถึงสื่อที่จะส่งไปยังจัดเก็บของคุณ; มันไม่ใช่แฟ้มวิดีโอหรือเสียง

บันทึกเป็น job_result.py และเรียก python3 job_result.py.

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))

จัดการกับความล่าช้าและความล้มเหลว

สถานการณ์วิธีแก้ไข
หมดเวลาการรับส่งข้อมูลแล้วA POST อาจได้รับการยอมรับแล้วก็ได้ Check ของคุณที่บันทึกไว้และประวัติบัญชีก่อนที่จะทําการแทนที่ POSs ซ้ํา สามารถสร้างงานใหม่ที่สามารถเรียกเก็บเงินได้
409 · result_not_readyให้ผลสํารวจสถานะ. อย่าสร้างงานอื่น
422 · result_not_readyงานล้มเหลว อ่าน job.error ก่อนทําการลองใหม่
429เกียรติ Retry-After หรือ retry_afterลดอัตราการรับส่งข้อมูลเมื่อความจุเต็ม
410 · result_expiredผลที่เก็บไว้จะหมดอายุเมื่อ 24 ชั่วโมงหลังจากเสร็จสมบูรณ์แล้ว ใช้สําเนาที่บันทึกไว้ของคุณ