Back to Documentation
Installation & Setup
Get up and running with 1cPlatform in under 5 minutes
Prerequisites
- Node.js 16.x or higher
- npm or yarn package manager
- 1cPlatform account (sign up free)
- API key from dashboard
Step 1: Install the SDK
Terminal
npm install @1cplatform/sdkOr using yarn:
yarn add @1cplatform/sdkStep 2: Get Your API Key
Navigate to your dashboard and generate an API key:
- Log in to 1cPlatform Dashboard
- Go to Settings → API Keys
- Click "Generate New Key"
- Copy your API key (keep it secure!)
Step 3: Initialize the Client
index.js
import { OneC } from '@1cplatform/sdk';
const client = new OneC({
apiKey: process.env.ONEC_API_KEY
});
// Verify connection
const status = await client.ping();
console.log('Connected:', status);