API Reference
Discover the endpoints available through elsia's developer API for integrating with our platform.
Core Endpoints
POST /api/v1/auth
Initiates authentication session with client credentials
{
"client_id": "string",
"redirect_uri": "uri",
"state": "string"
}
{
"auth_url": "uri",
"session_id": "uuid"
}
GET /api/v1/resources
Search for open-source resources and templates based on query parameters
Query
q
string
Category
category
string
GET /api/v1/resources?q=auth&category=template
{
"total": 14,
"resources": [
{
"id": "string",
"name": "string",
"type": "string",
"description": "string",
"stars": "integer",
"url": "uri"
}
]
}
POST /api/v1/scan
Execute security scanning on GitHub repositories
Owner
owner
string
Repository
repo
string
{
"owner": "string",
"repo": "string",
"depth": 10,
"branches": true
}
{
"scan_id": "uuid",
"status": "string",
"results_url": "uri",
"vulnerabilities": 14
}
Example Usage
JavaScript
fetch('https://api.elsia.dev/api/v1/resources?q=ci-cd', {
method: 'GET',
headers: {
'Authorization': 'Bearer YOUR_ACCESS_TOKEN'
}
})
.then(response => response.json())
.then(data => console.log(data));
Best Practices
1. Rate Limiting
We enforce rate limits of 1,000 requests/hour. Use pagination and caching where possible.
2. Authentication
Always use HTTPS and store tokens securely. Rotate credentials regularly in production systems.
3. Monitoring
Track API health metrics via our status page. Set up alerts for endpoint changes or outages.
4. Updates
Subscribe to changelog notifications for breaking changes and new endpoint availability.