HuntAPI

Node.js

Installez le SDK Node.js de HuntAPI et faites votre premier appel d'API.

Le SDK Node.js officiel de HuntAPI, avec une méthode typée par endpoint et un request() générique pour le reste.

Prérequis

  • Node.js 20+

Installation

npm install @huntapi/sdk

Obtenir votre clé API

Copiez votre clé API depuis le tableau de bord HuntAPI et placez-la dans la variable d'environnement HUNTAPI_API_KEY, que le SDK lit par défaut. Ne la versionnez pas.

Démarrage rapide

import { HuntApiClient } from "@huntapi/sdk";

const client = new HuntApiClient({ apiKey: process.env.HUNTAPI_API_KEY });

const response = await client.mediaMetadata({
  query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
});
console.log(response.data);

Jobs asynchrones

Les endpoints de téléchargement sont asynchrones : ils renvoient un job_id, et un job peut durer jusqu'à 12 heures. Le SDK peut attendre sa fin.

const submitted = await client.videoDownload({
  query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  video_quality: "720p",
});
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));

Erreurs

Une réponse hors 2xx lève une erreur d'API avec son statut et son message. Consultez les codes de statut pour la liste complète.

import { HuntApiApiError } from "@huntapi/sdk";

try {
  await client.mediaMetadata({
    query: "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  });
} catch (error) {
  if (error instanceof HuntApiApiError) {
    console.error(error.status, error.message, error.responseBody);
  }
  throw error;
}

Nouvelles tentatives

Les requêtes sont retentées jusqu'à 3 fois après une erreur réseau, un 408, 500, 502, 503 ou 504, ou une limite de débit du forfait. Les erreurs de quota par clé et les expirations côté client ne sont pas retentées. Le délai commence à 1 seconde et augmente de 1,5× à chaque tentative, et un en-tête Retry-After a la priorité.

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

// or for one request
await client.mediaMetadata(
  { query: "https://www.youtube.com/watch?v=Z5YP8kznWZs" },
  { maxRetries: 0 },
);

Requêtes par lots

Lancez plusieurs appels à la fois, 10 par défaut. Un échec n'arrête pas les autres.

const inputs = [
  "https://www.youtube.com/watch?v=Z5YP8kznWZs",
  "https://www.youtube.com/watch?v=jNQXAC9IVRw",
];
const results = await client.batch(
  inputs,
  (query) => client.mediaMetadata({ 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);
}

N'importe quel endpoint

request() atteint n'importe quel chemin, y compris les endpoints sortis après votre version du SDK.

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

Erreurs fréquentes

  • Mettre la clé API dans le code front-end. N'importe qui pourrait la lire. Appelez l'API depuis votre serveur.
  • Considérer tout 401 comme une mauvaise clé. Un 401 peut aussi signaler une limite de débit : lisez le message. Le SDK retente pour vous les limites du forfait.
  • Retenter un 402. Il n'y a plus de crédits ni de quota, donc une nouvelle tentative ne peut pas réussir. Consultez Crédits.
  • Attendre les requêtes longues. Au-delà de 60 secondes, utilisez le mode asynchrone comme ci-dessus plutôt que d'augmenter votre délai. Voir Timeout.

Liens

Sur cette page