Parcourir la documentation
Premiers pas
Installez le SDK et lancez une recherche dans Node.js. Choisissez TypeScript ou JavaScript et conservez les clés API côté serveur.
Installez le SDK
Ces exemples utilisent Node.js 22.18+ pour exécuter TypeScript directement. Commencez dans un dossier vide ou choisissez Projet existant si vous avez déjà un fichier package.json.
Installernpm init -y npm install --save-exact @flashdata-dev/[email protected]Installernpm install --save-exact @flashdata-dev/[email protected]Authentifiez-vous
Créez une clé autorisant Google Search ou réutilisez une clé autorisée. Définissez FLASHDATA_API_KEY dans ce terminal avec la saisie masquée ci-dessous ; ignorez cette étape si votre environnement la fournit déjà.
L’exemple transmet explicitement la clé. Ces scripts ne chargent pas les fichiers .env. Pour une application web, conservez la clé dans la configuration côté serveur.
Saisie masquée de la clé · 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_KEYSaisie masquée de la clé · PowerShell# PowerShell 7: paste the key into a hidden prompt. $flashdataSecureKey = Read-Host "FlashData API key" -AsSecureString $env:FLASHDATA_API_KEY = [System.Net.NetworkCredential]::new("", $flashdataSecureKey).Password Remove-Variable flashdataSecureKeyLancez une recherche
Enregistrez le fichier choisi et exécutez sa commande dans ce projet. Chaque exécution soumet une recherche demandant jusqu’à cinq résultats. Les deux fichiers s’exécutent directement avec Node.js, sans étape de compilation pour cet exemple.
quickstart.mtsimport { 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);Exécuter · Node.js 22.18+node quickstart.mtsquickstart.mjsimport { FlashData } 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 response = await client.google.search({ query: 'battery recycling research', num: 5 }); 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);Exécuternode quickstart.mjsVérifiez le résultat
Le script vérifie que status vaut done, puis affiche les titres, les URL et les crédits consommés. Un tableau organic vide est valide. La sortie ci-dessous illustre la structure attendue ; les sources réelles varieront.
Exemple de sortieBattery recycling research https://example.org/recycling Credits used: 0.02results[].organic[]- Titres, liens et extraits Google Search. Les autres sources ont leurs propres réponses typées.
usage.credits- Crédits facturés pour cette requête ; cinq résultats renvoyés correspondent à une seule requête de recherche.
Essayez une autre source de données
Chaque onglet fonctionne en TypeScript et en JavaScript. Remplacez le fichier de l’étape 3, conservez son extension .mts ou .mjs et exécutez la même commande. Chaque exécution est une nouvelle requête et nécessite la permission de source indiquée.
Nécessite google_news. Lisez les articles dans results[].news[].
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);Nécessite youtube_metadata. Renvoie les titres, les chaînes, les durées et d’autres informations sur les vidéos.
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.youtube.metadata({
video_id: 'dQw4w9WgXcQ', include_formats: false,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);Nécessite youtube_transcript. Demande une piste automatique anglaise existante. Le texte figure dans results[].fullText lorsque la piste est disponible.
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.youtube.transcript({
video_id: 'dQw4w9WgXcQ', language: 'en', auto: true,
});
if (response.status !== 'done') throw new Error(JSON.stringify(response));
console.log(response);Vérifier les types d’un projet TypeScript
Node exécute cet exemple en retirant les annotations de type. Pour vérifier les types sans envoyer de requête, installez TypeScript et lancez le compilateur avec --noEmit :
npm install --save-dev typescript@~5.9.3 @types/node@^22
npx tsc quickstart.mts --module nodenext --target es2022 --strict --noEmitFonctionnalités du SDK
google / youtube- Recherchez et récupérez des données structurées avec les méthodes typées propres à chaque source. Réutilisez un même client dans votre service.
youtube.download- Livrez de l’audio ou de la vidéo dans votre stockage cloud avec une tâche en arrière-plan. La permission youtube_download et une configuration de stockage sont nécessaires.
jobs / bulk- Enregistrez les identifiants des tâches soumises et récupérez les résultats terminés. await attend en JavaScript ; mode: 'async' soumet une tâche en arrière-plan côté serveur.
account- Consultez l’accès, le solde, les tarifs, les limites et la consommation avant les traitements récurrents.
respondWith / accept- Passez { respondWith: 'markdown' } comme deuxième argument de la méthode pour obtenir du Markdown dans response.content, ou { accept: 'text/plain' } pour une chaîne. Par défaut, les réponses sont des objets JSON.
Étapes suivantes
Si une étape échoue
- Paquet ou environnement d’exécution manquant
- Vérifiez node --version et installez @flashdata-dev/sdk dans ce projet. Conservez l’extension .mts ou .mjs indiquée ci-dessus.
- 401 / FLASHDATA_API_KEY
- Définissez une clé valide dans le terminal qui exécute l’exemple.
- 403
- Autorisez Google Search pour cette clé API.
- 402
- Consultez les crédits disponibles dans la facturation ou rattachez à votre compte un essai d’agent épuisé.
- 429
- Respectez le délai Retry-After, puis réduisez la fréquence de vos requêtes.
- Délai dépassé ou erreur serveur
- Consultez l’historique avant de renvoyer la requête ; la première peut avoir déjà été exécutée.