Chuyển đến nội dung
VI
Lấy khóa API
Duyệt tài liệu

Bắt đầu

API khởi chạy nhanh

nhỏ Google Search và YouTube ADI trực tiếp trên HTTP. Gửi một yêu cầu và đọc JSON Đáp ứng; không SDK là yêu cầu.

  1. Xác thực

    Tạo một tài khoản, kiểm tra email của bạn và tạo một phím bằng Google Search Cho phép. Bạn có thể dùng lại một phím đã có.

    Chạy trong terminal và dán khóa vào lời nhắc nhập ẩn. Bỏ qua nếu FLASHDATA_API_KEY đã được đặt.

    Đặt khóa
    # 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. Chạy tìm kiếm

    Chọn một khách hàng và chạy ví dụ trong cùng một thiết bị cuối. Mỗi người gửi một cái POST yêu cầu https://data.flashdata.dev/v1/queries/realtime và in ra JSON. Xác thực với X-API-Key; gửi JSON có Content-Type: application/json.

    cURL 7.76+ · Bash trên Linux, macOS hay Git Bash. Dán và chạy.

    Tìm kiếm # 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. Kiểm tra kết quả

    Xác nhận HTTP Thành công và status: done. Đọc tiêu đề nguồn, liên kết và trích đoạn vào results[].organicvà trách nhiệm ở usage.credits.

    Một danh sách kết quả hoặc hữu cơ rỗng status: done là kết quả rỗng hợp lệ.

    Câu trả lời mẫu
    {
      "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" xác nhận việc truy vấn đã thành công.
    results[0].organic[]
    Kết quả. Kiểm tra kết quả là chưa có kết quả trước khi chỉ mục nó.
    title / link / snippet
    Tựa nguồn, URL và trích đoạn.
    usage.credits
    Các tín dụng thực sự được tính vào yêu cầu này.

@ info/ rich

Để nắm bắt yêu cầu tiếp theo, thêm những tùy chọn này vào cURL ra lệnh ở trên. Kiểm tra các tập tin trước khi quyết định thử lại một yêu cầu sai.

cURL
--dump-header response-headers.txt --output result.json

Kiểm tra truy cập và tín dụng

Những GET yêu cầu đọc danh tính, số dư và giá trị mà không cần dùng thẻ truy vấn. Mong đợi HTTP 200 và kiểm tra cánh đồng bên dưới trước khi nộp tiền.

Tài khoản ghi: https://api.flashdata.dev/v2. Yêu cầu dữ liệu: https://data.flashdata.dev/v1. Cả hai đều dùng X-API-Key; JSON POST yêu cầu cũng được dùng Content-Type: application/json.

Kiểm tra miễn phí # 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
Xác nhận mục đích accountId, access: "ready"ống kính "google_search"và bất kỳ expiresAt. accountType là "owned" cho một chìa khóa chủ sở hữu hoặc "temporary" cho một cái chìa khóa thử nghiệm.
balance
Đọc availableCredits. Tất cả các chìa khóa của tài khoản này sử dụng cùng một sự số dư.
pricing
Đối với prices[0], xác nhận nguồn là google_search và sẵn sàng là true. So sánh estimatedCredits Vì requestCount: 1 có availableCredits. Giá cả và sự cân bằng có thể thay đổi trước khi phục tùng.

Bước kế

Nếu một bước không thành công

Hãy đọc câu trả lời được in trong thiết bị cuối. JavaScript và Python báo cáo HTTP lỗi và Retry-After phải stderr. Mỗi ví dụ đệ trình một lần; nó không tự động thử lại.

Lệnh mất hay tùy chọn không được hỗ trợ
Kiểm tra phiên bản cần thiết trong ví dụ đã chọn. Dùng PowerShell 7 thay vì Windows PowerShell 5.1hoặc dùng Bash có cURL 7.76+. JavaScript Cần nút 22+; Python cần 3.10+. Cài đặt thời gian chạy bị mất từ trang tải về chính thức, mở lại thiết bị cuối, sau đó đặt lại chìa khóa.
Thiếu chìa khóa / 401
Đặt FLASHDATA_API_KEY trong tiến trình này và kiểm tra lại danh tính. Cung cấp đầy đủ năng lượng API Chìa khóa, không có tiền tố. Nếu nó hết hạn hoặc bị thu hồi, hãy sử dụng một chứng nhận có thẩm quyền hiện thời; đừng dán nó vào bộ đàm.
403
Kiểm tra identity.scopes Vì google_search và tiếp cận sẵn sàng. Yêu cầu sự cho phép bị mất tích của chủ sở hữu; thay đổi nguồn trong yêu cầu không cho phép truy cập.
402
Hãy đọc lại sự số dư và so sánh nó với giá hiện tại. Chủ sở hữu có thể xem xét Billing. Một thử nghiệm kiệt sức cần người chủ tiếp cận thông qua việc tuyên bố; tạo ra một phiên tòa thay thế không phải là hồi phục.
400 / 422
Hãy đọc thông điệp lỗi đã được trả lại. Kiểm tra chính xác máy dữ liệu, POST Phương pháp, Content-Type và JSON tên thực địa. Dùng trích dẫn thẳng và số params.numVậy thì hãy sửa lại lời yêu cầu bị từ chối.
429
Tôn trọng Retry-After nếu có mặt; nếu không hãy dùng một sự lùi lại bị hạn chế và giảm sự nhất trí. Đừng lặp lại nhanh chóng, hãy tạo những phím mới hoặc đăng ký một thử nghiệm khác để vượt qua giới hạn.
HTTP 200 với trạng thái hoặc lỗi thất bại
Đọc lỗi trong cơ thể và bảo tồn bất kỳ yêu cầu hay công việc nào ID. Không được phân tích JSON Cơ thể là một nhiệm vụ thành công hoặc tự động phục hồi nó.
Kết quả trống
Nếu tình trạng đã được thực hiện, việc xác thực đã hoạt động. Giữ kết quả rỗng hoặc thử truy vấn rộng hơn là yêu cầu trả lương mới.
Thời hạn, mất kết nối, 5xx hoặc HTML thay vì JSON
A POST Có lẽ người ta đã chấp nhận ngay cả khi không có phản ứng gì. Kiểm tra History cho yêu cầu gốc và bảo tồn bất kỳ trả về nào IDs trước khi quyết định thay đổi. Tự do GET Có thể lấy lại tiền kiểm tra. Xác nhận URL sử dụng data.flashdata.devkhông phải máy nơi Mạng, cũng không tắt khả năng thẩm tra hệ điều hành của hệ thống phụ thuộc.