Introduction

Welcome to the RoofLink Public API! This API allows you to integrate with RoofLink's roofing business management platform.

Access to all API endpoints is served over TLS-encrypted secure channels, and therefore support for SSL/TLS encryption is required on the API client side. All endpoints required proper authentication (see the Authentication page for details).

If you have requests or questions about how to use our platform, please feel free to reach out to us using the Discussions page.

Base URL

All URLs referenced within the documentation have the following base:

https://integrate.rooflink.com/roof_link_endpoints/api

API Rate Limits

To prevent abuse of the RoofLink Public API, we impose the following limitations on the number of requests accepted by our servers:

Per Client Limits

Each client, identified per API Key (see the Authentication page for details), has a limit of 5 requests per second. If this rate is exceeded, the server will respond with an HTTP 429 status code (i.e., "Too Many Requests").

When receiving a 429 response, clients are advised to wait for a minimum of 2 seconds before making another attempt, preferably including an incremental wait time mechanism such as Exponential or Fibonacci backoff added to a randomized wait time.

Application-wide Limits

In case the maximum allowed rate for all clients is exceeded, the RoofLink API servers will respond to any received requests with an HTTP 503 status code ("Service Unavailable").

When receiving a 503 status code, clients are advised to follow the same recommendations as for the 429 status code response; however, using a minimum wait time of 60 seconds before retries.

Endpoint-specific Limitations

In exceptional cases, due to security or reliability reasons, a stricter rate limit may be imposed for specific endpoints. In this case, the description of the endpoints will include a rate limits section indicating the applicable limits for that particular endpoint.