API Reference
API Overview and Architecture
Base URLs All API requests use HTTPS. There are two environments: Environment Base URL Purpose Sandbox https://sandbox-api.aelix.digitalapi.ai Development and...
Tutorials
Going Live Checklist
Before You Go Live Going live with your Aelix integration is straightforward, but completing this checklist will prevent the most common production issues. ✅...
Getting Started
Getting Started with the Developer Portal
Welcome to Aelix Developer Portal The Aelix Developer Portal gives you everything you need to discover, integrate, and manage APIs at scale. This guide walks...
Authentication
Authenticating with OAuth 2.0
Overview Aelix APIs use OAuth 2.0 Client Credentials for server-to-server authentication. This flow is ideal for background services and daemons that need to...
Getting Started
Making Your First API Call with cURL
Prerequisites You will need cURL installed (curl --version to check) and an API key from the Developer Portal. Step 1 — Set Your Environment Variables Store...
Best Practices
Handling Errors and Retries
Understanding Error Responses All Aelix APIs return errors in a consistent JSON envelope, making it straightforward to parse and handle them programmatically:...
Integration
Implementing Webhooks
What are Webhooks? Webhooks allow Aelix to push real-time event notifications to your application rather than requiring you to poll for updates. They are ideal...
Best Practices
Working with Pagination
Pagination Strategies Aelix collection endpoints support two pagination styles. Check the API reference to see which style a specific endpoint uses....
Getting Started
Building a Postman Collection
Prerequisites Download and install Postman (free). Have your Aelix API key or OAuth credentials ready. Step 1 — Create an Environment In Postman, click...
Security
Securing Your API Integration
1 — Manage Secrets Properly Never hardcode API keys or client secrets in source code. Use a secrets manager: AWS Secrets Manager or Parameter Store for...