Changelog
added

API Versioning

API versioning offers your developers a predictable path to API upgrades while allowing Aurora to evolve our platform without impacting your existing API-based integrations. With Versions API, Aurora-API-Version HTTP header, and versioned API docs you will be able to self-manage our REST API version upgrades moving forward.

improved

High-resolution Imagery by Default

With this enhancement, you will get the best available imagery loaded by default for projects created via the Aurora API. No need to assign an owner to a project to obtain high-resolution images.

added

Leads API and Webhook Events

You can now programmatically retrieve leads created with Lead Capture AI and convert them into projects. The new API endpoints are accompanied by three webhook events: lead_created, lead_changed, and lead_converted. With [the new APIs] (ref:retrievelead) and webhook events, you can keep your IT ecosystem (e.g., CRM) synchronized with lead information in Aurora in real-time. Note that you have to be on the Aurora Custom plans to access APIs and webhooks.

improved

AutoDesigner API: Azimuth Range

You can now specify a minimum and maximum roof face azimuth (in degrees, where 0 is north and 180 is south) upon which panels are allowed to be placed. This gives you more control over customizing your output, but is not necessary to produce an optimal system (i.e., Energy Mode will already avoid placing panels on shaded faces).

improved

Additional fields in Update Project API

You can modify the following fields with Update Project API now in addition to the existing six fields.

improved

AutoDesigner API: Flat and Pitched Face Parameters

You can now customize panel tilt, spacing, and orientation depending on whether a roof face is flat or pitched in order to align with your design and installation best practices and maximize irradiance and system production.

added

Retrieve Asset API

With the Retrieve Asset endpoint, you can retrieve details of an individual asset (e.g., screenshot). You will likely want to use the Retrieve Asset endpoint to look up asset details including URLs on receipt of asset_created webhooks.

added

New Webhook Events

We added two new webhook events: consumption_profile_changed and asset_created. The consumption profile webhook event fires upon any change to a consumption profile in Aurora. The asset webhook event fires when an asset (e.g., screenshot, DXF file) is created and ready for download in Aurora. With the two new webhooks, you can keep applications in your IT ecosystem in sync with Aurora in real-time.

improved

HTTP Responses by Endpoint

We updated our API Reference to show a full list of HTTP responses that you might receive for each endpoint. With the list of responses, you can build better quality integrations with Aurora by proactively handling error states in your code.

added

API Tutorials

We published the first API tutorials. With our growing library of tutorials, you can automate the most common solar workflows with the Aurora API in less time and with better quality.