Skip to main content
This guide walks you through installing the PromoStandards SDK and setting up your development environment.

​
Prerequisites

Before you begin, ensure you have:
  • Node.js 16.x or higher - The SDK requires Node.js version 16 or later
  • npm, yarn, or pnpm - A package manager to install the SDK
  • PromoStandards credentials - Account ID and password from your supplier
  • API endpoints - Service URLs provided by your supplier
Most promotional product suppliers provide PromoStandards credentials through their developer portal or account settings.

​
Install the package

1

Install via your package manager

Choose your preferred package manager to install the SDK:
npm install promostandards-sdk-js --save
2

Verify installation

Confirm the SDK is installed by checking your package.json file:
package.json
{
  "dependencies": {
    "promostandards-sdk-js": "^0.1.11"
  }
}

​
TypeScript setup

The SDK includes built-in TypeScript type definitions. If you’re using TypeScript, you’ll get full type safety and autocomplete support out of the box. 
import { PromoStandards } from 'promostandards-sdk-js';

// TypeScript will provide full type checking and autocomplete
const client = new PromoStandards.Client({
  id: 'your-account-id',
  password: 'your-password',
  endpoints: [
    // Your endpoints configuration
  ],
});
No additional type packages are needed. The SDK ships with complete TypeScript definitions.

​
Node.js version requirements

The SDK requires Node.js 16.x or higher. To check your Node.js version: 
node --version
If you need to upgrade Node.js, visit nodejs.org or use a version manager like nvm.

​
Next steps

Now that you have the SDK installed, you’re ready to initialize a client and make your first API call.

Quickstart guide

Learn how to configure the client and make your first API request

Build docs developers (and LLMs) love

Get started for freeTalk to us