Developer Documentation
Everything you need to integrate SolProxyVault into your platform
Quick Start Guide
1
Request Platform Access
Submit a platform request through our registration form
2
Install SDK
npm install @solproxyvault/sdk3
Initialize Client
const client = new SolProxyVault({
platformId: 'your-platform-id',
apiKey: 'your-api-key'
})4
Start Integration
You're ready to register users and process transactions!
Platform Integration Overview
Step-by-step guide to integrate SolProxyVault into your platform
Prerequisites
- Node.js 16+ or compatible runtime environment
- Basic understanding of async/await and promises
- Approved platform account with API credentials
- HTTPS-enabled endpoint for webhooks (optional)
Installation
Install the SDK using your preferred package manager:
npm install @solproxyvault/sdkyarn add @solproxyvault/sdkpnpm add @solproxyvault/sdkConfiguration
Create a configuration file or environment variables:
// config/solproxyvault.js
export const config = {
platformId: process.env.SOLPROXYVAULT_PLATFORM_ID,
apiKey: process.env.SOLPROXYVAULT_API_KEY,
apiSecret: process.env.SOLPROXYVAULT_API_SECRET,
network: process.env.SOLPROXYVAULT_NETWORK || 'mainnet-beta',
webhookUrl: process.env.SOLPROXYVAULT_WEBHOOK_URL // optional
}Security Note
Never commit API credentials to version control. Use environment variables or secure key management systems.
Core Concepts
Platform Account
Your platform's identity in the system. Controls user namespaces, fees, and configurations.
User Credentials
Simple username/password authentication. No wallet management required by users.
System Secret
Backend-only secret that provides additional security layer for all transactions.
Two-Phase Transactions
Authorize with user credentials, then execute with system secret for enhanced security.
Need Help?
Our developer support team is here to help you integrate successfully