Installation

Installez listingsapi-js depuis npm, choisissez ESM ou CJS et vérifiez votre configuration.

Prérequis

• Node.js 18 ou version ultérieure
• npm, pnpm ou yarn

Le SDK utilise fetch en natif (intégré à Node 18+) et ne nécessite aucune dépendance à l'exécution.

• Code source : github.com/listings-api/listingsapi-nodejs-sdk
• Versions : npmjs.com/package/listingsapi-js

Installation

npm install listingsapi-js

# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-js

ESM et CJS

listingsapi-js inclut une version compilée au format ESM et une autre au format CommonJS. Le point d'entrée approprié est sélectionné automatiquement en fonction du paramètre type de votre projet.

ESM ("type": "module" dans package.json ou extension .mts/.mjs) :

import { ListingsAPI, APIError } from 'listingsapi-js';

CJS (résolution des modules par défaut de Node ou extension .cts/.cjs) :

const { ListingsAPI, APIError } = require('listingsapi-js');

TypeScript

Les définitions de types sont incluses dans le paquet : aucun @types/listingsapi-js distinct n'est donc nécessaire. Le SDK est écrit en TypeScript et le dossier dist/ contient des fichiers .d.ts (et .d.cts pour la version compilée au format CommonJS) pour tous les exports.

# No extra step needed: types come with the packagenpm install listingsapi-js

Fixer la version

Cette documentation est testée avec listingsapi-js 0.3.2.

npm install listingsapi-js@0.3.2

Ou dans package.json :

{"dependencies": {  "listingsapi-js": "^0.3.2"}}

Vérification

import { ListingsAPI } from 'listingsapi-js'; const client = new ListingsAPI({ apiKey: 'your-api-key' });console.log('listingsapi-js ready', typeof client.fetchAllLocations);

npx tsx verify.ts

Étapes suivantes

• Démarrage rapide : connectez-vous et effectuez votre premier appel à l'API
• Configuration : remplacement de l'URL de base et configuration d'un projet TypeScript