Introduction
Welcome to the RiderX RESTful API documentation. Our API provides four main methods: Authentication, Booking, Quotation, and Delivery Inquiry, that allow developers to connect their applications with our RiderX Android APP. We envision a comprehensive ecosystem of applications that support our delivery riders users, and this API is a crucial component of that ecosystem.
We are committed to providing our users with the best possible experience. Our API is designed to help developers create innovative applications that can enhance the delivery experience for both our riders and customers. This documentation assumes that you have a basic understanding of RESTful APIs and HTTP methods.
Target Audience
This documentation is intended for two main groups of programmers and developers:
1.
Developers who want to integrate their applications with Rider X's delivery services using RESTful API. If you are building an application that requires delivery services, such as an e-commerce site or a food delivery app, this documentation will guide you on how to connect to our system and make use of our delivery services.
2.
Developers who want to provide services to Rider X's users using RESTful API. If you are building an application that can provide value to our users, such as a tracking application or a shipping calculator, this documentation will provide the necessary information on how to access our API and retrieve data from our system.
Terms of Usage
By using our RESTful API, you agree to the following terms:
1.
You will develop applications that connect to RiderX API that comply with the laws and regulations of the countries where they will be implemented. It is your responsibility to ensure that your application adheres to all relevant laws and regulations.
2.
You will use the API for lawful purposes only. You will not use the API to engage in any illegal activity or to violate the rights of any individual or entity.
3.
You will not use the API in a way that could harm the stability, security, or availability of our system. You will not attempt to disrupt or interfere with the normal operation of our API or any related services.
4.
You will not use the API to transmit any viruses, malware, or other harmful code. You will take all necessary precautions to ensure that your application is free from any harmful code that could affect our system or our users.
5.
You will not attempt to access any unauthorized parts of our system. You will only use the API to access data that is made available through the API.
6.
We reserve the right to modify, suspend, or terminate the API at any time without prior notice. We will make reasonable efforts to notify you of any changes to the API that may affect your application.
If you have any questions or concerns about these terms, please contact our support team.
Rate Limits
To ensure the stability and availability of our system, we have implemented rate limits for our RESTful API. The rate limits are as follows:
1. Authentication: X requests per minute
2. Booking: X requests per minute
3. Quotation: X requests per minute
4. Delivery Inquiry: X requests per minute
5. Status Inquiry: X requests per minute
6. Dispatch: X requests per minute
If you exceed the rate limits, your requests will be rejected, and you will receive a 429 Too Many Requests response. To avoid rate limit issues, we recommend that you implement caching mechanisms in your application to reduce the number of requests made to our API.
Please note that we reserve the right to modify the rate limits at any time without prior notice. If you have any questions or concerns about rate limits or need a higher rate limit for your application, please contact our support team.
Contact Information
For technical inquiries related to the RiderX API, please email our technical support team at team@ridex.team . Our technical support team will be happy to assist you with any technical issues you may have with our API.
For sales inquiries related to the RiderX API, please email our sales team sales@riderx.team . Our sales team will be happy to provide you with information about pricing, billing, and any other sales-related inquiries you may have.