Aurora released a new API version to make backward-incompatible changes. To avoid disrupting your integration and breaking your code, we don’t change your version automatically. When you are ready, you can upgrade to the latest version in Aurora settings, or by using Versions API. The following are breaking changes in version 2024.05.
You can now subscribe to the design_request_created webhook event. The webhook payload can include <DESIGN_REQUEST_ID> and <SOURCE>, and it can be filtered on source. This webhook event will fire when a design request is created in the Aurora app or via API, enabling your IT ecosystem (e.g., CRM) to keep design request data in sync.
With the <SOURCE> URL parameter in the auto_designer_job_completed, fire_pathway_placement_job_completed, panel_irradiance_analysis_job_completed and performance_simulation_job_completed webhooks, you can ensure your Design API integration is triggered by machine (rather than user) actions.
With the new max_panel_spacing field for List Racking Arrays API, you can now configure the maximum spacing used to determine which panels belong to an array. With max_panel_spacing field, you can configure the maximum spacing between modules that define an array. This can be used for conforming inter module spacing based on mounting hardware clamp and spacing requirements.
You can now subscribe to project_changed webhook event. This webhook will fire when one of the project attributes listed below changes. The webhook payload includes <PROJECT_ID>, <SOURCE> and <ATTRIBUTES> , allowing you to quickly determine whether the update is relevant to your workflow.
You can now download the racking bill of materials (BOM) by navigating to the Project > Documents page. The racking BOM will become available after you have completed your racking design in the app and the manufacturer has posted the binary file with BOM information as “Racking Bill of Materials” asset_type using Create Design Asset API. With the human readable bill of materials, your Operations team can streamline your hardware procurement practices and reduce supply chain costs.
The Leads API now includes a new field, maximum_module_count, which provides the maximum number of solar panels that fits on the roof once modeled. The field can be read using the Retrieve Lead API. This is in addition to the already included field, module_count, which provides the number of solar panels to offset the provided energy usage.
The Retrieve Roof Summary API now includes a count of obstructions in the obstructions object, which contains two fields: circle_count and polygon_count. With known obstruction counts, you can further streamline your design quality assurance process by automatically matching obstruction data in Aurora to other sources (e.g., site survey results).
The List Racking Arrays API now lists all contiguous arrays in the adjacent_arrays field so you can easily identify arrays that can be racked together. For example, when array A is adjacent to array B, and array B is adjacent to array C, adjacent_arrays field will now indicate that A and C are part of a contiguous grouping of panels. With enhanced contiguous array data, you can, among other things, better model your racking system designs to match panel placement on the roof.
The Users API now includes two fields, base_price_per_watt_max and base_price_per_watt_min, for managing an allowable base price-per-watt (PPW) range, adding guardrails for users who interact with pricing, and protecting margins on sold projects. The fields can be written using the Update User or Create User APIs, and read using the Retrieve User API. When a design's base PPW is changed to conflict with the PPW rule for the project's assigned user, a warning will appear in app for that user and anyone with access to the project.
