Roof-Calc Management REST API
Introduction
This API is currently unavailable, please check back later for more details.
Welcome to the Roof-Calc quote, product and stock management REST API. This API is intended SOLELY for automatically updating merchant product details (including pricing and stock/availability) and managing merchant quotes.
Access
Base URL
The base URL for this API is https://api.roof-calc.co.uk/${version} where version is some sequential MAJOR version string such as v1, v2, v3. The latest/current version path will be used across the API reference within each endpoint URL.
Authentication
Access to this API is authenticated ONLY by means of a JWT Bearer token in the request headers tied to a specific merchant account with api scope set.
Your merchant's JWT API Key can be found and regenerated in the Roof-Calc Dashboard using an account with manager privileges by clicking on "Integrations Details" in the bottom part of the left nav and looking for the "JWT API Key" field.
Please store your JWT API Key securely for example using environment variables. Either periodically, or in the event that you suspect the JWT API key has been compromised in any way, you MUST regenerate it through the Roof-Calc Dashboard. REGENERATING THE JWT API KEY WILL INVALIDATE THE EXISTING KEY.
Further details are available in the OpenAPI security schemes for this API (see here).
Rate Limiting
This API uses various rate limits to ensure fair service availability for all users and to protect against abuse. We do not disclose the exact details of our rate limiting policy, however making not more than 4 requests per second over a sustained period should prevent your requests from being refused. Some additional allowance is available for burst requests, however the API is NOT intended for sustained frequent use.
Any request may be rejected by returning an HTTP 429 response (Too Many Requests). In this event we recommend waiting for a period of time not less than 60 seconds before attempting to make any additional requests. Continued requests in excess of the imposed rate limits following an HTTP 429 response will be deemed as abuse of the API and may result in permanent request throttling or termination of your account subject to Section 11.2 of our Terms of Use (see here).
Legal
Terms of Use
By using this API, you agree to be bound by our Terms of Use policy (see here). Subject to Section 11.2 of these Terms of Use (see here), if you are found to be in contravention of these Terms of Use, your access to this API and its associated software may be terminated immediately.
License
Copyright (C) FlexiProof Limited. All rights reserved.
This API is provided as a part of proprietary software built and maintained by FlexiProof Limited (company number 09132601. Under Section 2.3 of our Terms of Use policy (see here), it is NOT permitted to resell or redistribute any parts of this software.
Authentication
- JWT Bearer Auth
JWT Bearer token tied to a specific merchant account with api scope set.
Security Scheme Type: | http |
|---|---|
HTTP Authorization Scheme: | Bearer |
Bearer format: | JWT |
Contact Roof-Calc Support: [email protected]