Installation

Installieren Sie listingsapi-js über npm, wählen Sie ESM oder CJS und überprüfen Sie Ihre Einrichtung.

Voraussetzungen

Node.js 18 oder neuer
npm, pnpm oder yarn

Das SDK verwendet natives fetch (in Node 18+ integriert) und hat keine Laufzeitabhängigkeiten.

Quellcode: github.com/listings-api/listingsapi-nodejs-sdk
Versionen: npmjs.com/package/listingsapi-js

Installation

bash

npm install listingsapi-js

bash

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

ESM und CJS

listingsapi-js enthält sowohl einen ESM-Build als auch einen CommonJS-Build. Der passende Einstiegspunkt wird automatisch anhand der Einstellung type Ihres Projekts ausgewählt.

ESM ("type": "module" in package.json oder Dateiendung .mts/.mjs):

TypeScript

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

CJS (standardmäßige Modulauflösung von Node oder Dateiendung .cts/.cjs):

JavaScript

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

Typdefinitionen sind im Paket enthalten, daher ist kein separates @types/listingsapi-js erforderlich. Das SDK ist in TypeScript geschrieben, und der Ordner dist/ enthält für alle Exporte .d.ts-Dateien (sowie .d.cts für den CommonJS-Build).

bash

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

Version festlegen

Diese Dokumentation wurde mit listingsapi-js 0.3.2 getestet.

bash

npm install listingsapi-js@0.3.2

Oder in package.json:

json

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

Überprüfung

verify.ts

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

bash

npx tsx verify.ts

Nächste Schritte

Schnellstart: Verbindung herstellen und Ihren ersten API-Aufruf ausführen
Konfiguration: Basis-URL überschreiben und TypeScript-Projekt einrichten