Installation

Follow these steps to install and set up our platform in your environment.

Prerequisites

Before you begin, ensure you have the following installed:

  • Node.js 18.0 or higher
  • npm 8.0 or higher (or yarn/pnpm)
  • A code editor of your choice

Installation Steps

Install our SDK using your preferred package manager:

npm install @acme/sdk
bash

Configuration

After installation, you need to configure the SDK with your API key:

// Create a configuration file (e.g., acme-config.js)
import { defineConfig } from '@acme/sdk';

export default defineConfig({
  apiKey: process.env.ACME_API_KEY,
  environment: 'production', // or 'development', 'staging'
  timeout: 30000, // request timeout in milliseconds
});
javascript

We recommend storing your API key in environment variables for security.

Verification

Verify your installation by running a simple test:

import { Client } from '@acme/sdk';

// Initialize the client
const client = new Client();

// Test the connection
async function testConnection() {
  try {
    const status = await client.system.status();
    console.log('Connection successful:', status);
  } catch (error) {
    console.error('Connection failed:', error);
  }
}

testConnection();
javascript
Was this page helpful?
Last updated on 3/19/2025