Base URL
In previous sections, we discussed how to obtain credentials and how to use them to make successful requests to Reserhub Data Lake APIs.
In this section, we explain the details of the base URL for requests to Reserhub Data Lake APIs.
Base URL Structure
The base URL is the entry point for all requests to our APIs.
Its structure is as follows:
https://[client-domain].com/api/v1/Where:
[client-domain]is the specific domain assigned to each clientapi/v1/indicates that you are accessing version 1 of the API
Obtaining your Base URL
Each client receives a unique base URL to ensure secure and exclusive access to their data.
The process is as follows:
- Testing Base URL
Initially, you will be provided with a base URL for the sandbox testing environment.
- Production Base URL
Once your integration is ready for production, you will be assigned your definitive base URL.
It is important that you request your base URL along with your API access credentials as soon as you are ready to begin integration with our Data Lake, as its enablement is not immediate.
Version Updates
Reserhub Data Lake implements improvements and new functionalities continuously. When a major API update occurs, you will be notified about the version change.
For example, if you currently use:
https://your-domain.com/api/v1/And you need to update to version 2, the new base URL would be:
https://your-domain.com/api/v2/We recommend maintaining communication with the technical team to verify that you are using the correct API version.
Best Practices
To maintain consistency with the rest of the documentation, we suggest:
- Using the base URL as an environment variable named
BASE_URL - Verifying the correct URL structure before making requests
- Keeping your API version up to date