SDK TypeScript

Si votre équipe développe en JavaScript ou en TypeScript, le SDK est le moyen le plus rapide de connecter une application à freedam. Au lieu d’écrire vous-même toute la plomberie bas niveau d’une intégration d’API – requêtes, nouvelles tentatives, pagination des longues listes, attente de la fin des traitements –, vous installez un seul paquet et chaque partie de la bibliothèque est à un simple appel de méthode.

Ce qu’il fait

@freedam/sdk est le client officiel de l’API REST de freedam. Il fonctionne dans tous les environnements JavaScript habituels – Node, Bun, Deno et le navigateur – et il est généré directement à partir de la description publiée de l’API elle-même : il correspond donc toujours à ce que l’API fait réellement.

Tout ce que contient la bibliothèque est directement disponible sur le client : médias, collections, imports, partages, opérations en arrière-plan, métadonnées, webhooks, et plus encore. Comme le client est entièrement typé, votre éditeur complète automatiquement les appels disponibles et signale un nom de champ erroné pendant que vous tapez, avant que quoi que ce soit ne s’exécute.

import { FreedamClient } from '@freedam/sdk';

const client = new FreedamClient({
    baseUrl: 'https://your-instance.example.com',
    token: process.env.FREEDAM_TOKEN!,
});

const { data } = await client.assets.list({ per_page: 50 });

Comment ça marche

Au-delà de la couverture de chaque endpoint, le SDK prend en charge les corvées que vous écririez sinon vous-même :

• Une pagination simplifiée. Récupérez une page, parcourez les pages au fur et à mesure de vos besoins, ou obtenez tout en un seul appel.
• Les imports comme un flux. Démarrez un lot, envoyez vos fichiers, puis suivez l’avancement jusqu’à ce que chaque fichier soit entièrement traité.
• Les traitements en arrière-plan. Lancez une modification en masse ou un export, puis attendez simplement qu’il se termine – le SDK vérifie l’avancement à votre place jusqu’à la fin du traitement.
• La sécurité des webhooks. Un seul appel vérifie qu’une notification de webhook entrante vient bien de votre instance freedam.
• Des nouvelles tentatives automatiques. Les incidents réseau temporaires et les erreurs serveur sont retentés pour vous, et le client ralentit automatiquement quand on le lui demande : il respecte ainsi les limites de débit de l’API sans code supplémentaire.

Quand quelque chose se passe mal, les erreurs sont claires et précises : le SDK vous dit si un média est introuvable, si une requête a été limitée en débit ou si une signature ne correspond pas, pour que votre code réagisse proprement à chaque cas.

À savoir

• L’accès fonctionne comme partout ailleurs – vous créez un token API dans Paramètres → Tokens API avec exactement les permissions dont votre intégration a besoin. Le SDK n’ajoute aucune porte dérobée : un token qui ne peut pas modifier les médias ne peut pas non plus les modifier via le SDK.
• Le SDK est jeune. Les versions antérieures à la 1.0 peuvent parfois changer les noms : épinglez votre version et lisez le journal des modifications fourni dans le paquet (CHANGELOG.md) avant de mettre à jour. L’API elle-même reste stable, indépendamment.
• Vous ne travaillez pas en TypeScript ? La description publiée de l’API fonctionne avec des outils standard pour générer un client dans la plupart des autres langages.

La référence complète des méthodes et les modèles d’utilisation sont dans la documentation de l’API. Envie d’une instance en ligne sur laquelle pointer le client pendant votre développement ? Essayez la démo.