Pinvpn Logo

SDK Documentation

Integrate our platform into your applications using our official SDKs.

Available SDKs

Node.js SDK

npm install @platform/sdk

Python SDK

pip install platform-sdk

Java SDK

implementation 'com.platform:sdk:1.0.0'

Quick Start Examples

Node.js

import { Platform } from '@platform/sdk';

const platform = new Platform({
  apiKey: 'your-api-key'
});

// List policies
const policies = await platform.policies.list();

// Create a risk assessment
const assessment = await platform.risks.create({
  title: 'New Risk Assessment',
  type: 'security',
  impact: 'high'
});

Python

from platform_sdk import Platform

platform = Platform(api_key='your-api-key')

# List policies
policies = platform.policies.list()

# Create a risk assessment
assessment = platform.risks.create(
    title='New Risk Assessment',
    type='security',
    impact='high'
)

Java

import com.platform.sdk.Platform;
import com.platform.sdk.models.*;

Platform platform = new Platform("your-api-key");

// List policies
PolicyList policies = platform.policies().list();

// Create a risk assessment
Risk assessment = platform.risks().create(
    new RiskCreateParams()
        .setTitle("New Risk Assessment")
        .setType("security")
        .setImpact("high")
);

Error Handling

try {
  const result = await platform.someOperation();
} catch (error) {
  if (error instanceof PlatformAPIError) {
    console.error('API Error:', error.message);
    console.error('Status:', error.status);
    console.error('Code:', error.code);
  }
}

Best Practices

  • Initialize SDK once and reuse the instance
  • Implement proper error handling
  • Use environment variables for API keys
  • Keep SDKs updated to latest versions
  • Monitor SDK operation metrics