Überspringen zum Inhalt
DE
API-Schlüssel
Dokumentation durchsuchen

Erste Schritte

TypeScript und JavaScript SDK

Installieren Sie SDK und führen Sie eine Suche in Node.js aus. Wählen Sie TypeScript oder JavaScript; behalten Sie die API-Schlüssel auf dem Server.

  1. Installieren Sie den SDK

    Diese Beispiele verwenden Node.js 22.18+, um TypeScript direkt auszuführen. Starten Sie in einem leeren Ordner oder wählen Sie Existierendes Projekt aus, wenn Sie package.json haben.

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

    Erstellen Sie einen Schlüssel mit der Google Search-Berechtigung oder verwenden Sie einen autorisierten Schlüssel erneut. Setzen Sie FLASHDATA_API_KEY in diesem Terminal mit der versteckten Eingabeaufforderung unten; überspringen Sie dies, wenn Ihre Umgebung es bereits bereitstellt.

    Das Beispiel übergibt den Schlüssel explizit. Eine .env-Datei wird von diesen Skripten nicht geladen. Behalten Sie den Schlüssel in der serverseitigen Konfiguration bei der Integration in eine Webanwendung.

    Versteckte Tastenaufforderung · 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. Suche ausführen

    Speichern Sie die ausgewählte Datei und führen Sie den Befehl in diesem Projekt aus. Jeder Durchlauf sendet eine Suche nach bis zu fünf Ergebnissen. Beide Dateien laufen direkt mit Node.js; für dieses Beispiel ist kein Build-Schritt erforderlich.

    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);
    Laufen · Node.js 22.18+
    node quickstart.mts
  4. Ergebnis prüfen

    Das Skript prüft den Status ist fertig und druckt Quelltitel, URLs und verwendete Credits aus. Leere organische Ergebnisse sind gültig. Die Beispielausgabe unten veranschaulicht die Form; Live-Quellen variieren.

    Beispielausgabe
    Battery recycling research https://example.org/recycling
    Credits used: 0.02
    results[].organic[]
    Google Search Titel, Links und Snippets. Andere Quellen haben ihre eigenen getippten Nutzlasten.
    usage.credits
    Credits für diese anfrage berechnet; fünf zurückgegebene hits sind eine suchanfrage.

Probieren Sie eine andere Datenquelle

Jeder Tab funktioniert sowohl in TypeScript als auch in JavaScript. Ersetzen Sie die Datei aus Schritt 3, behalten Sie ihre .mts- oder .mjs-Erweiterung bei und führen Sie den gleichen Befehl aus. Jeder Durchlauf ist eine neue Anforderung und benötigt die angezeigte Quellberechtigung.

Erfordert google_news. Lesen Sie Artikeleinträge 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);

Typprüfung eines TypeScript-Projekts

Node führt dieses Beispiel durch Strippen von Typen aus. Um Typen zu überprüfen, ohne eine Anforderung zu senden, installieren Sie TypeScript und führen Sie den Compiler mit --noEmit aus:

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

Was der SDK unterstützt

google / youtube
Suchen und Abrufen strukturierter Daten mit getippten Quellhelfern. Verwenden Sie einen Client in Ihrem Service wieder.
youtube.download
Liefern Sie Audio oder Video über einen Hintergrundauftrag an Ihren Cloud-Speicher. Erfordert youtube_download Berechtigung und Speicherkonfiguration.
jobs / bulk
Speichern Sie eingereichten Job IDs und holen Sie abgeschlossene Ergebnisse ab. warten Sie in JavaScript; mode: 'async' sendet einen serverseitigen Hintergrundjob.
account
Lesen Sie Zugang, Balance, Preise, Limits und Nutzung vor wiederkehrenden Arbeiten.
respondWith / accept
Geben Sie { respondWith: 'markdown' } als zweites Argument der Methode für Markdown in response.content oder { accept: 'text/plain' } für einen String weiter. JSON-Objekte sind standardmäßig.

Nächste Schritte

Wenn ein Schritt fehlschlägt

Paket oder Laufzeit fehlt
Überprüfen Sie den Knoten --version und installieren Sie @flashdata-dev/sdk in diesem Projekt. Behalten Sie die oben gezeigte .mts- oder .mjs-Erweiterung bei.
401 / FLASHDATA_API_KEY
Legen Sie einen gültigen Schlüssel in dem Terminal fest, in dem Sie das Beispiel ausführen.
403
Aktivieren Sie Google Search für diesen API Schlüssel.
402
Überprüfen Sie Billing auf verfügbare Credits oder fordern Sie eine erschöpfte Agentenstudie an.
429
Warten Sie auf Retry-After und reduzieren Sie dann Ihre Anfragerate.
Timeout oder Serverfehler
Überprüfen Sie History vor dem erneuten Senden; die erste Anforderung wurde möglicherweise bereits ausgeführt.