Getting Started

Installation & Setup

Open in Claude

Install the Vim Connect Backend SDK and what your server needs to run it

Prerequisites

  • Node.js 20.19 or later (22.12 or later on Node.js 22). The package is ESM: import it, or require() it from CommonJS.
  • Your service app's clientId and clientSecret.
  • The id of an account that has installed your app. A token is minted for one account, and only once that account has an active install.

Installation

npm install @vimconnect/backend-sdk zod

zod 4 is a peer dependency.

Next Steps

  • Quick Start: construct a client and make your first call.
  • Configuration: every option VimConnectBackendClient accepts.

On this page