Getting Started

Getting Started 🚀

Step-by-step guide to integrating and using our developer platform's core features.

Quick Start Example


curl -X POST "{domain}/auth/validate"
  -H "Content-Type: application/json"
  -H "Authorization: Bearer YOUR_API_KEY"
  -d '{"token": "your_session_token"}'

1. Set Up Your Development Environment

Requirements

✅ Node.js 16+
✅ NPM or Yarn
✅ API Key (obtained from dashboard)
✅ Terminal/Command Prompt

Verification


npm install -g api-sdk
api-sdk validate-token YOUR_API_KEY

✅ Should return HTTP 200 with token details

2. Initialize SDK Project

Using the CLI


npx api-sdk init
npm install
npm start

This generates a basic project structure with:

Authentication handlers
Resource managers
Configuration templates

3. Your First API Call

JavaScript SDK Example


const client = new APIClient({
  endpoint: "{domain}/",
  apiKey: "YOUR_API_KEY"
});

client.validateToken("session_token_123")
  .then(response => console.log("Valid:", response));

Expected Response


{
  "valid": true,
  "userId": "U12345",
  "scopes": ["read:resources", "write:users"]
}

⚠️ API keys with insufficient scopes will block this action.

Developer Docs