Installation

​

Requirements

• Node.js 18 or later, Bun 1 or later, or Deno 1.39 or later. The SDK uses the runtime’s built-in fetch.
• An API key from the dashboard. Call the API from your server: a key used in a web page is visible to anyone who opens it.

​

Install

npm install @vepler/sdk

pnpm add @vepler/sdk

yarn add @vepler/sdk

bun add @vepler/sdk

​

Set your API key

export VEPLER_API_KEY="vpr_live_..."

import { SDK } from "@vepler/sdk";

const sdk = new SDK({ apiKeyAuth: process.env.VEPLER_API_KEY });

const { SDK } = require("@vepler/sdk");

const sdk = new SDK({ apiKeyAuth: process.env.VEPLER_API_KEY });

​

Check the key

const types = await sdk.heritage.types();
console.log(types.data.length);

​

TypeScript settings

{
  "compilerOptions": {
    "target": "es2020",
    "lib": ["es2020", "dom", "dom.iterable"],
    "module": "nodenext",
    "moduleResolution": "nodenext"
  }
}

• lib needs dom and dom.iterable: the SDK’s type definitions use Fetch types such as RequestInfo and HeadersInit, and without them tsc reports errors in those files unless skipLibCheck is on.
• moduleResolution must be nodenext, node16 or bundler for imports from subpaths such as @vepler/sdk/sdk/models/errors. The older node setting cannot resolve them.
• With a bundler, "module": "esnext" and "moduleResolution": "bundler" also work.

​

Troubleshooting