Rechercher dans la documentation

Trouver une page ou une section

SDK JavaScript / TypeScript

Installation

Terminal
npm install @generale-ci/sdk

Exemple minimal

TypeScript
import { GeneraleCI } from '@generale-ci/sdk';
 
const gci = new GeneraleCI({ apiKey: process.env.GCI_API_KEY! });
 
// Parcours du catalogue : le SDK gère la pagination par curseur pour toi.
for await (const article of gci.items.list()) {
  console.log(article.name, article.price);
}

Ce qu’il apportera

  • Typage TypeScript des articles, commandes et évènements de webhook.
  • Pagination par curseur transparente.
  • Vérification de signature de webhook en une ligne, avec la tolérance de 5 minutes déjà appliquée.
  • Erreurs converties en exceptions portant le message français de l’API.

En attendant

Tout est faisable en HTTP direct :