Introduction
Welcome to the Alentis API documentation. This documentation provides comprehensive information about the Alentis REST API for programmatic access to your solar portfolio.
What is the Alentis API?
The Alentis API allows you to programmatically access and manage your organisation's data, including:
- Sites: Setting up your sites
- Portfolios: Collections of sites for organization
- Documents: Files and reports associated with sites
Getting Started
To get started with the Alentis API:
- Generate an API Key - Learn how to create and manage API keys
- Understand Objects and Relationships - Learn about sites, portfolios, and documents
- Explore the API Reference - Interactive API documentation
Base URL
All API requests should be made to:
https://app.alentisenergy.com
Quick Example
# Get all your sites
curl -H "x-api-key: your-api-key-here" \
https://app.alentisenergy.com/api/sites
Next Steps
- Read about Authentication to learn how to generate and use API keys
- Understand Objects and Relationships to learn how the API is structured
- Explore the API Reference for detailed endpoint documentation
Support
For support, please contact Alentis Support.