Ga naar de inhoud
NL
API-sleutel ophalen
Documentatie bekijken

Aan de slag

TypeScript & JavaScript SDK

Installeer de SDK en zoek in Node.js. Kies TypeScript of JavaScript; houd API sleutels op de server.

  1. Installeer de SDK

    Deze voorbeelden gebruiken Node.js 22.18+ om TypeScript direct te draaien. Start in een lege map, of selecteer bestaand project als u package.json heeft.

    Installeren
    npm init -y
    npm install --save-exact @flashdata-dev/[email protected]
  2. Authenticeren

    Maak een sleutel aan met Google Search toestemming of hergebruik een geautoriseerde sleutel. Stel FLASHDATA_API_KEY in in deze terminal met behulp van de verborgen prompt hieronder; sla dit over als uw omgeving het al levert.

    Het voorbeeld gaat expliciet voorbij aan de sleutel. Een .env-bestand wordt niet door deze scripts geladen. Houd de sleutel in server-side configuratie bij het integreren in een webapplicatie.

    Verborgen sleutelprompt · 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. Een zoekopdracht uitvoeren

    Sla het geselecteerde bestand op en voer het commando in dit project uit. Elke run dient een zoekopdracht voor maximaal vijf resultaten. Beide bestanden draaien direct met Node.js; er is geen bouwstap nodig voor dit voorbeeld.

    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+ uitvoeren
    node quickstart.mts
  4. Het resultaat controleren

    Het script controleert de status is gedaan en drukt brontitels, URLs en gebruikte credits af. Lege biologische resultaten zijn geldig. De voorbeelduitvoer hieronder illustreert de vorm; levende bronnen zullen variëren.

    Voorbeelduitvoer
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search titels, links en knipsels. Andere bronnen hebben hun eigen getypte lading.
    usage.credits
    Credits in rekening gebracht voor dit verzoek; vijf teruggekeerde hits zijn een zoekopdracht.

Probeer een andere gegevensbron

Elk tabblad werkt in zowel TypeScript als JavaScript. Vervang het bestand van stap 3, houd de .mts of .mjs extensie en voer hetzelfde commando. Elke run is een nieuw verzoek en heeft de getoonde bron toestemming nodig.

Vereist google_news. Lees artikel in 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);

Typ-check een TypeScript-project

Knooppunt draait dit voorbeeld door strippen types. Om types te controleren zonder een verzoek te versturen, installeer TypeScript en voer de compiler uit met --noEmit:

Facultatief typecontrole
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmit

Wat de SDK ondersteunt

google / youtube
Gestructureerde gegevens zoeken en ophalen met getypte bronhelpers. Hergebruik één klant in uw dienst.
youtube.download
Lever audio of video naar uw cloudopslag via een achtergrondtaak. Vereist youtube_download toestemming en opslagconfiguratie.
jobs / bulk
Opslaan ingezonden taak IDs en afgeronde resultaten ophalen. wacht in JavaScript; mode: 'async' dient een server-side achtergrondtaak in.
account
Lees toegang, evenwicht, prijzen, limieten en gebruik voordat u opnieuw werkt.
respondWith / accept
Geef { respondWith: 'markdown' } door als tweede argument van de methode voor Markdown in response.content, of { accept: 'text/plain' } voor een string. JSON-objecten zijn standaard.

Volgende stappen

Als een stap mislukt

Pakket of looptijd ontbreekt
Controleer knooppunt --version en installeer @flashdata-dev/sdk in dit project. Houd de .mts of .mjs uitbreiding hierboven weergegeven.
401 / FLASHDATA_API_KEY
Stel een geldige sleutel in in de terminal waar u het voorbeeld uitvoert.
403
Schakel Google Search in voor deze API sleutel.
402
Controleer Billing op beschikbare credits, of claim een test met uitgeputte middelen.
429
Wacht op Retry-After en verlaag dan uw aanvraagsnelheid.
Timeout of serverfout
Controleer History alvorens opnieuw te versturen; het eerste verzoek kan al uitgevoerd zijn.