Getting Started
Get up and running with Elysium Nexus APIs in minutes. This guide covers authentication, basic API calls, and common workflows.
Prerequisites
- An API key provisioned by the Elysium team (format:
ely_sk_...) - Basic familiarity with REST APIs and HTTP requests
- A tool like cURL, Postman, or your preferred HTTP client
Authentication
All API requests require a Authorization header with a Bearer token. Your API key identifies your tenant and scopes all data operations.
Authorization: Bearer ely_sk_YOUR_API_KEYNote: Contact the Elysium team to get your API key provisioned. Keys support RBAC scopes and can be rotated without downtime.
Fetch Your Data
Start by fetching your customer list to verify connectivity and authentication.
curl -X GET "https://api.elysium-nexus.com/v1/customers" \ -H "Authorization: Bearer ely_sk_YOUR_API_KEY"
This returns a paginated list of customers with their basic information. Use query parameters like ?limit=50&offset=0 for pagination.
Calculate Business Health Index
Trigger BHI calculation for all customers in your tenant. This analyzes transaction patterns, account health, and generates actionable insights.
curl -X POST "https://api.elysium-nexus.com/v1/bhi/calculate-from-db" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ely_sk_YOUR_API_KEY" \
-d '{}'Then fetch the portfolio summary:
curl -X GET "https://api.elysium-nexus.com/v1/bhi/summary" \ -H "Authorization: Bearer ely_sk_YOUR_API_KEY"
Automate with Workflows
Workflows automate multi-step processes like data sync, BHI calculation, and NBA generation. Trigger them via API:
curl -X POST "https://api.elysium-nexus.com/v1/workflows/wf-123/trigger" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer ely_sk_YOUR_API_KEY" \
-d '{"input": {"customerId": "cust-456"}}'Workflows can also be scheduled (cron-based) or triggered by events. See the API Reference for details.