ข้ามไปยังเนื้อหา
TH
รับคีย์ 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 ร่าง กาย จะ ทํา งาน ที่ ประสบ ความ สําเร็จ หรือ จะ ทํา การ เปลี่ยน แปลง ใหม่ โดย อัตโนมัติ.
ผลการค้นหา:
หากทําสถานะแล้ว การตรวจสอบสิทธิ์ก็ใช้ได้ เก็บผลที่ว่างอยู่ หรือพยายามสอบถามแบบกว้างกว่านี้ เป็นการร้องขอที่ต้องจ่ายใหม่
เวลานอก, การสูญเสียการเชื่อมต่อ, 5x หรือ HTML แทน JSON
A POST อาจจะถูกยอมรับถึงแม้ว่าการตอบรับจะสูญหายก็ตาม ตรวจสอบ History สําหรับการค้นหาต้นฉบับและรักษาการกลับมาใด ๆ IDs ก่อนที่จะตัดสินใจแก้ไขใหม่ ว่าง GET เช็คสามารถตรวจสอบได้ ยืนยัน URL ใช้ data.flashdata.devไม่ใช้โฮสต์ของเว็บไซต์ และไม่ปิดการตรวจสอบความถูกต้องของการเข้ารหัสแบบ TLS