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

เริ่มต้นใช้งาน

TypeScript & JavaScript SDK

ติดตั้ง SDK และทําการค้นหาใน Node.js. เลือก TypeScript หรือ JavaScript. . เก็บ API กุญแจบนเซิฟเวอร์

  1. ติดตั้ง SDK

    ตัวอย่างเหล่านี้ใช้ Node.js 22.18เพิ่มที่ประมวลผล TypeScript ตรงๆเลย เริ่มในโฟลเดอร์ว่าง หรือเลือกโครงการที่มีอยู่ หากคุณมี package.json.

    ติดตั้ง
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. การตรวจสอบสิทธิ์

    สร้างกุญแจด้วย Google Search อนุญาตหรือใช้กุญแจที่ได้รับอนุญาตอีกครั้ง ตั้งค่า FLASHDATA_API_KEY ในเทอร์มินัลนี้ โดยใช้ตัวกระตุ้นที่ซ่อนอยู่ด้านล่างนี้; ข้ามที่นี่ไป หากสภาพแวดล้อมของคุณได้จัดเตรียมเอาไว้แล้ว

    ตัว อย่าง นี้ ถ่ายทอด กุญแจ อย่าง ชัดเจน. แฟ้ม .env ไม่ได้ถูกโหลดโดยสคริปต์เหล่านี้ เก็บกุญแจไว้ในการปรับแต่งของเซิร์ฟเวอร์ด้านข้าง เมื่อมีการรวมเข้ากับโปรแกรมต่าง ๆ

    แจ้งเตือนปุ่มซ่อน as 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. เรียกใช้การค้นหา

    บันทึกแฟ้มที่เลือกไว้และประมวลผลคําสั่งในโครงการนี้ แต่ละการทํางานจะส่งหนึ่งการค้นหาถึงห้าผลลัพธ์ แฟ้มทั้งสองทํางานโดยตรงด้วย Node.js(; ไม่ จําเป็น ต้อง มี ขั้น ตอน ใน การ สร้าง สําหรับ ตัว อย่าง นี้.

    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);
    เรียกใช้ '' Node.js 22.18+
    node quickstart.mts
  4. ตรวจสอบผลลัพธ์

    การตรวจสอบสคริปต์เสร็จสิ้นแล้ว และการพิมพ์ชื่อต้นฉบับ URLs และใช้เครดิต ผลของออร์แกนิคว่างเปล่าใช้ได้ ตัว อย่าง ที่ ออก มา ข้าง ล่าง นี้ แสดง ให้ เห็น รูป ร่าง; แหล่ง ที่ มี ชีวิต จะ แตก ต่าง ออก ไป.

    ตัวอย่างผลลัพธ์
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search ชื่อเพลง, ลิงก์และชิ้นส่วน แหล่งข่าวอื่น ๆ มีกระสุนชนิดของตัวเอง
    usage.credits
    เครดิตค่าใช้จ่ายสําหรับคําขอนี้; ห้าตีกลับมาเป็นหนึ่งการร้องขอการค้นหา

ลองแหล่งข้อมูลอื่น

แท็บแต่ละตัวใช้ได้ทั้งคู่ TypeScript ถึง JavaScript. แทนที่แฟ้มจากขั้นที่ 3, ให้คงนามสกุล .mts หรือส่วนขยาย mpjs และประมวลผลคําสั่งเดียวกัน การเรียกทํางานแต่ละครั้งเป็นการร้องขอใหม่ และต้องการสิทธิ์ในการแสดงแหล่งข้อมูล

ต้องมีสิทธิ์ google_news อ่านรายการบทความจาก 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);

พิมพ์- กาเลือกโครงการ TypeScript

โหนดดําเนินการตัวอย่างนี้โดยชนิดการลอกเลียน ให้ทําการตรวจสอบชนิดของรายการโดยไม่ต้องส่งการร้องขอให้ติดตั้ง TypeScript และเรียกตัวรวบรวม --noEmit:

ตรวจสอบชนิดเสริม
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

อะไรกันนี่ SDK สนับสนุน

google / youtube
ค้นหาและดึงข้อมูลที่มีโครงสร้างกับแหล่งข้อมูลพิมพ์ ช่วยลูกความคนหนึ่งในบริการคุณ
youtube.download
ส่งเสียงหรือวิดีโอไปยังที่เก็บเมฆของคุณผ่านทางงานเบื้องหลัง ต้องการ youtube_download อนุมัติและบันทึกการปรับแต่ง
jobs / bulk
บันทึกงานที่ส่งแล้ว IDs และรับผลที่เสร็จสมบูรณ์แล้ว รออยู่ใน JavaScript; mode: 'async' ส่งงานเบื้องหลังของแม่ข่าย
account
อ่าน เข้าถึง, สมดุล, ประเมินค่า, จํากัด และการใช้งาน ก่อนการทํางานซ้ํา
respondWith / accept
ผ่าน { respondWith: 'markdown' } เป็นวิธีการโต้แย้งที่สองสําหรับ Markdown ใน response.contentหรือ { accept: 'text/plain' } สําหรับเชือก JSON วัตถุเป็นค่าปริยาย

ถัดไป

ถ้าขั้นตอนล้มเหลว

แพกเกจหรือไม่พบเวลาทํางาน
ตรวจสอบโหนด --version และติดตั้งflashdata-dev/sdk ในโครงการนี้ เก็บส่วนขยาย .mts หรือ .mmjs ที่แสดงอยู่ด้านบน
401 / FLASHDATA_API_KEY
ตั้งค่ากุญแจที่ถูกต้องในเทอร์มินัลที่คุณเรียกใช้งานตัวอย่าง
403
เปิด Google Search สําหรับสิ่งนี้ API กุญแจ
402
ตรวจสอบเครดิตที่ใช้ได้ใน Billing หรือผูกสิทธิ์ทดลองใช้ของเอเจนต์ที่หมดเครดิตแล้วกับบัญชี
429
รอ Retry-After แล้วลดอัตราการร้องขอของคุณ
หมดเวลาหรือเซิร์ฟเวอร์ผิดพลาด
ตรวจสอบ History ก่อนจะทําการแก้ไขการร้องขอแรกอาจจะทํางานอยู่แล้ว