Quickr | API Documentation

IntroductionCopied!

Welcome to Quickr's API documentation! This API enables developers to access the full range of Quickr’s data and tools for creating scans, designs, and more, allowing you to integrate data and tools seamlessly to enhance your workflow and optimize solar and battery projects. 

Older versions

For previous versions of the Quickr API documentation, please refer to api.novasole.nl

Purpose of Quickr

Novasole develops Quickr, a platform for the solar industry that can be used as a comprehensive all-in-one solution or integrated via API. The Quickr API streamlines the creation of solar installation plans for next-gen energy companies, allowing users to efficiently manage and enhance solar projects. With accurate, quickly generated plans, this API enables faster installations and more effective project management. 

Getting StartedCopied!

The following steps will help you get started with using our API:

Registration and Login

  1. Receive login credentials:

    1. After your account is created by the Sales team, you will receive an email with your login credentials and a default password.  

    2. This email contains an activation link.  

  2. Activate your account:

    1. Click on the link in the email. This link will activate your account. 

    2. After logging in to Quickr, immediately change your default password to something personal and secure.   

Using the API

  1. Obtain a bearer token:

    1. Once you're logged in to the API using the Login endpoint, you'll receive a bearer token that grants you access to the API, allowing you to start making requests. Please refer to the next page for more information.

    2. The API has specific endpoints that you can call, depending on what you want to do (e.g., retrieving, adding, or updating data). 

  2. Start using the API:

    1. Use the available API documentation to make the appropriate requests.  

By following this process, you can easily complete the registration, activate your account, log in, and start using the API. It is important to keep your password secure and change it periodically. 

Support

If you have any questions or encounter issues while using the Quickr API, you can contact our support at Support@novasole.nl