Aurora Solar has a public API that lets users build apps and integrations with the Aurora platform.
Our APIs enable your organization to scale by creating efficient and seamless workflows, minimizing data loss, mistakes, and time to make manual data transfers that allows Aurora users to do the following at a high level:
- Create, retrieve, and update projects
- Create, retrieve, and accept design requests
- Create blank design and retrieve design details including simulation outputs
- Retrieve design assets, pricing, financings, and agreement metadata
- Triggering a post-sales workflow in your IT ecosystem on homeowner's e-signing the agreement
Your CRM must be able to accommodate the following criteria to integrate fully with Aurora’s API library:
- An event in the client CRM sends a POST request for the creation of Aurora entities such as a Project, Design, or Design Request.
- Clicking a custom button in the CRM is a common way for a user to initiate this action.
- For example, a “Create Project in Aurora” button in your CRM triggers a POST request to create a project in Aurora.
- The CRM triggers an event to “Sync” data back from Aurora to the corresponding CRM object via a GET request.
- CRM’s must have the ability to create customized fields to sync data back from Aurora to those corresponding fields.
- For workflows utilizing a CRM’s automation tool, ensure that the current CRM object can be updated within the same workflow, such as with a unique record ID.
- The CRM is able to map field values from a CRM object into an API call, as well as map data returned from an API call back to the original CRM object.
- For example, when you call Create Project via API, there is a unique lead_id field in your CRM (i.e. “123”). To send contact details, such as Name, Address, and Email, these fields must be mapped into the payload of the POST request to Aurora. For additional details on this process, see a tutorial linked here.
- For API workflows utilizing webhooks, the CRM must accept incoming webhooks from Aurora.
- Oftentimes, CRMs are able to handle only outgoing webhooks based on events happening in the CRM, such as a lead being converted.
- Webhooks from Aurora are GET requests, so the UUIDs and values are included in the query string of the URL template and do not carry a payload.
- It is recommended that you speak to your CRM provider and inquire if the CRM can handle incoming 3rd party webhooks & share with them the URL template format and attributes of an Aurora webhook.
- The CRM has an internal structure in place to denote one to many relationships (i.e. one Project to multiple Designs).
- It can be the case that for a certain project in Aurora you create multiple designs for it. For example, say you created a project for 901 Mears Ct, Stanford, CA 94305, USA. Within this project, you are able to create multiple designs, such as one with 7 kW system size design and another 10 kW system size design.
- Maintain a table or subform to show one-to-many relationships, such as one Project having multiple Designs. This allows users to store and manage multiple designs for a single project and sync between them as needed.
- For workflows that utilize saving a screenshot file (DXF or PNG), the CRM can store or display the screenshot in a field.
For a deeper look into common integrations that we have seen organizations leverage using Aurora’s API and webhooks, take a look at our Tutorials section.