API Overview
The lllgggoss API provides programmatic access to our platform's core functionality. This documentation will guide you through key concepts, authentication, and available endpoints.
// Install client SDK
npm install @lllgggoss/api
// Initialize client
const client = new LllgggossAPI({ apiKey: 'YOUR_KEY' });
Authentication
API Keys
Use your API key in the Authorization header with Bearer schema.
Authorization: Bearer YOUR_KEY
OAuth 2.0
For server-to-server authentication using OAuth tokens.
POST /oauth/token
{
"client_id": "YOUR_ID",
"client_secret": "YOUR_SECRET",
"grant_type": "client_credentials"
}
Endpoints
Core Endpoints
GET /api/v2/data
Parameters
- resource: string (required)
- format: string (json/csv)
- depth: number (1-5)
Example Request
GET /api/v2/data?type=users
Authorization: Bearer YOUR_KEY
Response
{
"success": true,
"data": [...],
"meta": {...}
}
POST /api/v2/operation
Payload
{
"action": "create",
"resource": "project",
"payload": { ... }
}
Usage
Create, update, or remove resources through this endpoint. All requests require a valid session token.
Status 201 Created | 400 Bad Request | 401 Unauthorized | 422 Invalid Data
Webhooks
Event Types
-
resource_created
Triggered when new resources are created
-
resource_updated
Fires when resource attributes change
-
data_modified
Triggered during bulk data operations
Implementation
-
1
Register your endpoint in the developer dashboard
-
2
Configure event subscriptions
-
3
Verify signature with HMAC-SHA256
POST /your/webhook/endpoint
Content-Type: application/json
X-Event-Signature: hex