Authentication

Before making any requests to the RoofLink Public API, an API Key will be required for authentication.

Once authenticated using the API Key, all requests will be executed acting on behalf of the owner of the company account.

How to Generate Your API Key

To generate an API Key for your company, please follow these steps:

1. Log-in to the RoofLink web application
2. Visit your "Company Settings page"
3. Click on the "API Keys section"
4. Click on "Create API Key"
5. Copy the generated API Key, and store it in a secure location, such as a password manager or your application's dedicated secrets storage (for example, an environment variable or managed secrets service).

Please note that the API Keys can be used to authenticate to the RoofLink Public API as a user of your company, and thus it will provide access and allow manipulation of all your company data.

Users are responsible for securing and managing their API Keys. We recommend these to be stored in a password manager application with a secure master password and enabled two factor authentication or in encrypted configurations or a secrets manager.

API Keys do not expire until they are manually disabled, or deleted from the application. These actions can be done by visiting the same API keys from step 3.

How to Use Your API Key

Include your API Key in the X-API-KEY header with every API request:

curl --request GET \
     --url https://integrate.rooflink.com/roof_link_endpoints/api/light/jobs/ \
     --header 'X-API-KEY: {{insert_your_api_key_here}}' \
     --header 'Accept: application/json'