Node.js

Das offizielle Node.js-SDK von Veille mit einer typisierten Methode pro Endpunkt und einem generischen request() für alles andere.

VoraussetzungenAnkerlink kopieren

• Node.js 20+

InstallationAnkerlink kopieren

npm install @veilleio/sdk

API-Schlüssel erhaltenAnkerlink kopieren

Kopieren Sie Ihren API-Schlüssel aus dem Veille-Dashboard und legen Sie ihn in der Umgebungsvariable VEILLE_API_KEY ab, die das SDK standardmäßig liest. Checken Sie ihn nicht in die Versionsverwaltung ein.

SchnellstartAnkerlink kopieren

import { VeilleClient } from "@veilleio/sdk";

const client = new VeilleClient({ apiKey: process.env.VEILLE_API_KEY });

const response = await client.intelligenceEmail({
  query: "jane.doe@example.com",
});
console.log(response.data);

Asynchrone JobsAnkerlink kopieren

Jeder Aufruf akzeptiert is_async, nützlich jenseits des Serverlimits von 60 Sekunden. Die Antwort ist dann eine job_id, und das SDK kann auf das Ende des Jobs warten.

const submitted = await client.intelligenceEmail({
  query: "jane.doe@example.com",
  is_async: true,
});
const job = await client.waitForJob(submitted.data.job_id, {
  onProgress: (j) => console.log(`${j.status} ${j.progress ?? 0}%`),
});
console.log(JSON.stringify(job.data, null, 2));

FehlerAnkerlink kopieren

Eine Antwort außerhalb von 2xx löst einen API-Fehler mit Status und Meldung aus. Die vollständige Liste finden Sie unter Statuscodes.

import { VeilleApiError } from "@veilleio/sdk";

try {
  await client.intelligenceEmail({ query: "jane.doe@example.com" });
} catch (error) {
  if (error instanceof VeilleApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}

WiederholungenAnkerlink kopieren

Anfragen werden bis zu 3-mal wiederholt nach einem Netzwerkfehler, einem 408, 500, 502, 503 oder 504 oder einem Ratenlimit des Tarifs. Kontingentfehler pro Schlüssel und clientseitige Timeouts werden nicht wiederholt. Die Wartezeit beginnt bei 1 Sekunde und wächst pro Wiederholung um das 1,5-Fache; ein Retry-After-Header hat Vorrang.

const client = new VeilleClient({ maxRetries: 5, retryDelay: 500 });

// or for one request
await client.intelligenceEmail(
  { query: "jane.doe@example.com" },
  { maxRetries: 0 },
);

Batch-AnfragenAnkerlink kopieren

Führen Sie viele Aufrufe gleichzeitig aus, standardmäßig 10. Ein Fehler stoppt die anderen nicht.

const inputs = [
  "jane.doe@example.com",
  "john@mailinator.com",
  "contact@veille.io",
];
const results = await client.batch(
  inputs,
  (query) => client.intelligenceEmail({ query }),
  { concurrency: 5 },
);

for (const result of results) {
  if (result.status === "fulfilled") console.log(result.value.data);
  else console.error(inputs[result.index], result.reason);
}

Beliebiger EndpunktAnkerlink kopieren

request() erreicht jeden Pfad, auch Endpunkte, die nach Ihrer SDK-Version erschienen sind.

const response = await client.request("GET", "/v1/usage");

Häufige FehlerAnkerlink kopieren

• Den API-Schlüssel in Frontend-Code einbauen. Jeder könnte ihn lesen. Rufen Sie die API von Ihrem Server auf.
• Jeden 401 als falschen Schlüssel behandeln. Ein 401 kann auch ein Ratenlimit sein: Lesen Sie die Meldung. Das SDK wiederholt Tarif-Ratenlimits automatisch.
• Einen 402 wiederholen. Es sind keine Credits oder Kontingente mehr übrig, eine Wiederholung kann also nicht gelingen. Siehe Credits.
• Auf lange Anfragen warten. Nutzen Sie ab 60 Sekunden den asynchronen Modus wie oben gezeigt, statt das Timeout zu erhöhen. Siehe Timeout.

LinksAnkerlink kopieren

• Paket: @veilleio/sdk
• Quellcode: github.com/veilleio/veille-node
• API-Referenz