perculus-sdk v0.0.9

Perculus Node.js SDK

Welcome to the official Perculus Node.js SDK! This SDK provides a set of tools for integrating with the Perculus platform, allowing developers to easily interact with Perculus APIs and services.

Installation

Install the SDK via npm:

npm install perculus-sdk

Or, if you use yarn:

yarn add perculus-sdk

Or, if you use pnpm:

pnpm add perculus-sdk

Getting Started

To get started with the Perculus SDK, you first need to initialize it with your credentials. You can find your API keys and account ID in the Perculus dashboard.

From Code

import APIClient from "perculus-sdk"

// Initialize the Perculus SDK
const client = new APIClient()

// Authenticate
client.setDomain("your-domain")
client.setCredentials({
  accessKey: "your-access-key",
  secretKey: "your-secret-key",
  accountId: "your-account-id"
})

From Environment Variables

You can also set your credentials using environment variables:

export PERCULUS_DOMAIN="your-domain"
export PERCULUS_ACCESS_KEY="your-access-key"
export PERCULUS_SECRET_KEY="your-secret-key"
export PERCULUS_ACCOUNT_ID="your-account-id"

Then, initialize the SDK without passing credentials:

import APIClient from "perculus-sdk"

// Initialize the Perculus SDK
const client = new APIClient()

Documentation

Full documentation and API reference can be found in our Perculus Developer Wiki. Here, you'll find comprehensive guides, code examples, and troubleshooting tips to help you make the most out of the Perculus SDK.