Listings APIListings API
登入

安裝

從 npm 安裝 listingsapi-js，選擇 ESM 或 CJS，並確認設定是否正確。

需求

  • Node.js 18 或更新版本
  • npm、pnpm 或 yarn

SDK 使用原生 fetch（Node 18 以上版本內建），且沒有任何執行階段相依套件。

安裝

bash
npm install listingsapi-js
bash
# pnpmpnpm add listingsapi-js # yarnyarn add listingsapi-js

ESM 與 CJS

listingsapi-js 同時包含 ESM 與 CommonJS 建置版本。系統會根據您專案的 type 設定，自動選擇正確的進入點。

ESM（在 package.json 中設定 "type": "module"，或使用 .mts/.mjs 副檔名）：

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

CJS（使用 Node 預設的模組解析方式，或使用 .cts/.cjs 副檔名）：

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

TypeScript

套件已包含型別定義，因此不需要另外安裝 @types/listingsapi-js。SDK 以 TypeScript 撰寫，dist/ 資料夾包含所有匯出項目的 .d.ts 檔案（以及供 CommonJS 建置版本使用的 .d.cts）。

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

固定版本

本文件的內容已使用 listingsapi-js 0.3.2 測試。

bash
npm install listingsapi-js@0.3.2

或在 package.json 中設定：

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

驗證

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

後續步驟

  • 快速入門：連線並進行您的第一次 API 呼叫
  • 設定：覆寫基底 URL 與設定 TypeScript 專案