HuntAPI

Java

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

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

Prérequis

  • Java 17+

Installation

Le SDK Java n'est pas sur Maven Central. Compilez-le depuis les sources pour l'installer dans votre dépôt Maven local, puis ajoutez-le à votre projet.

git clone https://github.com/huntapi/huntapi-java.git
cd huntapi-java
mvn -q install -DskipTests
Maven
<dependency>
  <groupId>com.huntapi</groupId>
  <artifactId>huntapi</artifactId>
  <version>0.1.0</version>
</dependency>
Gradle
implementation("com.huntapi:huntapi:0.1.0")

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 com.huntapi.ApiResponse;
import com.huntapi.HuntApiClient;
import com.huntapi.params.MediaMetadataParams;

HuntApiClient client = HuntApiClient.fromEnv();
ApiResponse response = client.mediaMetadata(MediaMetadataParams.builder().query("https://www.youtube.com/watch?v=Z5YP8kznWZs").build());
System.out.println(response.json().toPrettyString());

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.

ApiResponse submitted = client.videoDownload(VideoDownloadParams.builder().query("https://www.youtube.com/watch?v=Z5YP8kznWZs").videoQuality("720p").build());
ApiResponse job = client.waitForJob(
    submitted.json().get("job_id").asText(),
    Duration.ofSeconds(3),
    Duration.ofHours(12),
    progress -> System.out.println(progress.path("status").asText() + " " + progress.path("progress").asInt()));

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.

try {
  client.mediaMetadata(MediaMetadataParams.builder().query("https://www.youtube.com/watch?v=Z5YP8kznWZs").build());
} catch (HuntApiApiException e) {
  System.err.println(e.status() + ": " + e.getMessage());
}

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é.

HuntApiClient client = HuntApiClient.builder().maxRetries(5).retryDelay(Duration.ofMillis(500)).build();
client.mediaMetadata(MediaMetadataParams.builder().query("https://www.youtube.com/watch?v=Z5YP8kznWZs").build(), RequestOptions.builder().maxRetries(0).build()); // one request without retries

Requêtes par lots

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

List<String> inputs = List.of("https://www.youtube.com/watch?v=Z5YP8kznWZs", "https://www.youtube.com/watch?v=jNQXAC9IVRw");
List<BatchResult<ApiResponse>> results = client.batch(inputs, 5, value ->
    client.mediaMetadata(MediaMetadataParams.builder().query(value).build()));
for (BatchResult<ApiResponse> result : results) {
  if (result.ok()) {
    System.out.println(result.value().json());
  } else {
    System.err.println(inputs.get(result.index()) + ": " + result.error().getMessage());
  }
}

N'importe quel endpoint

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

ApiResponse response = client.request("GET", "/v1/usage", Map.of());

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