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

Bắt đầu

TypeScript & JavaScript SDK

Cài đặt SDK và tìm kiếm trong Node.js. Chọn TypeScript hay JavaScript; giữ API Chìa khóa trên máy chủ.

  1. Cài đặt SDK

    Những ví dụ này được dùng Node.js 22.18+ để chạy TypeScript trực tiếp. Bắt đầu trong một thư mục rỗng, hoặc chọn dự án tồn tại nếu bạn có package.json.

    Cài đặt
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Xác thực

    Tạo một phím bằng Google Search Cho phép hoặc sử dụng lại một khóa có thẩm quyền. Đặt FLASHDATA_API_KEY trong thiết bị cuối này, sử dụng dấu nhắc ẩn bên dưới; bỏ qua nếu môi trường của bạn đã cung cấp nó.

    Ví dụ cho thấy rõ ràng chìa khóa. Tập tin .env không được tải bởi các tập lệnh này. Giữ phím trong cấu hình bên máy phục vụ khi tích hợp vào ứng dụng web.

    Phím ẩn nhắc điều · Bash
    # 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
  3. Chạy tìm kiếm

    Lưu tập tin đã chọn và chạy lệnh trong dự án này. Mỗi lần chạy một lần tìm kiếm kết quả là năm kết quả. Cả hai tập tin chạy trực tiếp với Node.js; không cần phải có bước xây dựng cho ví dụ này.

    quickstart.mts
    import { FlashData, type GoogleSearchParams } from '@flashdata-dev/sdk';
    
    const apiKey = process.env.FLASHDATA_API_KEY;
    if (!apiKey) throw new Error('Set FLASHDATA_API_KEY in the server environment.');
    const client = new FlashData({ apiKey });
    const params: GoogleSearchParams = { num: 5 };
    const response = await client.google.search({ query: 'battery recycling research', ...params });
    if (response.status !== 'done') throw new Error(JSON.stringify(response));
    
    for (const page of response.results) {
      for (const hit of page.organic ?? []) console.log(hit.title, hit.link);
    }
    console.log('Credits used:', response.usage.credits);
    Chạy · Node.js 22.18+
    node quickstart.mts
  4. Kiểm tra kết quả

    Kiểm tra tình trạng tập lệnh đã được thực hiện và in tựa nguồn, URLs và dùng tín dụng. Kết quả hữu cơ rỗng là hợp lệ. Thí dụ xuất ra bên dưới minh họa hình dạng; các nguồn sống sẽ khác nhau.

    Đầu ra Ví dụ
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search Đầu đề, liên kết và đoạn trích. Các nguồn khác có các loại hàng hóa riêng.
    usage.credits
    Tín dụng cho lời yêu cầu này; năm lần trở lại là một yêu cầu tìm kiếm.

Thử một nguồn dữ liệu khác

Mỗi thẻ làm việc trong cả hai TypeScript và JavaScript. Thay thế tập tin từ bước 3Giữ nó mở rộng hay mở rộng ra và chạy cùng một mệnh lệnh. Mỗi lần chạy là một yêu cầu mới và cần có sự cho phép từ nguồn.

Yêu cầu google_news. Đọc mục nhập bài trong results[].news[].

quickstart.mts / quickstart.mjs
import { FlashData } from '@flashdata-dev/sdk';

const apiKey = process.env.FLASHDATA_API_KEY;
if (!apiKey) throw new Error('Set FLASHDATA_API_KEY first.');
const client = new FlashData({ apiKey });
const response = await client.google.news({
  query: 'battery recycling', num: 5,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);

Kiểm tra gõ một dự án TypeScript

Nút chạy ví dụ này bằng cách lột đồ loại. Để kiểm tra các kiểu mà không gửi yêu cầu, cài đặt TypeScript và chạy trình biên dịch --noEmit:

Kiểm tra kiểu tùy chọn
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

Hỗ trợ SDK là gì?

google / youtube
Tìm kiếm và thu thập dữ liệu cấu trúc với hỗ trợ nguồn đã gõ. Hãy tái sử dụng một khách hàng trong dịch vụ của anh.
youtube.download
Chuyển âm thanh hoặc video đến kho đám mây thông qua một công việc nền. Yêu cầu youtube_download Cho phép và lưu trữ cấu hình.
jobs / bulk
Lưu công việc đã gửi IDs và lấy kết quả đã hoàn tất. Đang đợi kết quả vào JavaScript; mode: 'async' Đang gửi một tác vụ nền của máy chủ.
account
Đọc sách, giữ thăng bằng, giá cả, giới hạn và sử dụng trước khi làm việc lặp lại.
respondWith / accept
Qua { respondWith: 'markdown' } là đối số thứ hai của phương pháp cho Markdown in response.content, hoặc { accept: 'text/plain' } cho một sợi dây. JSON Đối tượng là sự mặc định.

Bước kế

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

Gói hoặc chạy thời gian thiếu
Kiểm tra nút --version và cài đặtflashdata-dev/sdk trong dự án này. Giữ phần mở rộng .mjs được hiển thị bên trên.
401 / FLASHDATA_API_KEY
Đặt một phím hợp lệ trong thiết bị cuối nơi bạn chạy ví dụ.
403
Bật Google Search Vì cái này API Chìa khóa.
402
Kiểm tra Billing hoặc tuyên bố một vụ thử nghiệm tác nhân kiệt sức.
429
Chờ Retry-After, sau đó giảm tốc độ yêu cầu.
Lỗi quá giờ hoặc máy chủ
Kiểm tra History trước khi phục hồi, có lẽ yêu cầu đầu tiên đã chạy rồi.