Introducing
Welcome to the API documentation for our system! Here, you'll find everything you need to seamlessly integrate and interact with our carwash services programmatically. Our API empowers you to harness the power of our carwash infrastructure, providing real-time access to essential functionalities and data. From managing payments and monitoring carwash status from our users, you'll find the tools you need to streamline operations and deliver exceptional service.
Explore our documentation to discover detailed information on endpoints, parameters, authentication methods, and more. We've designed our API with simplicity and efficiency in mind, ensuring seamless integration into your existing systems and workflows. We use the following icons within the endpoint details to provide additional information about the endpoint:
This category of endpoints within our API does not require an API token for access. Developers can freely utilize these endpoints to access public information or perform actions that don't require authentication.
These endpoints within our API require an API token for access. Developers must authenticate themselves with a valid token to utilize these endpoints, ensuring security and control over sensitive data or actions. This token must be included in the request header using the format "X-Api-Token: 123abc". Access to these endpoints might be restricted to authorized users or specific functionalities.
These endpoints within our API require a user token for access. Developers must first obtain a valid token through the generate user token endpoint. This token must be included in the request header using the format "Authorization: tok_123abc". Token expiration is configurable per reseller, allowing for flexible session management and security control.
These endpoints are currently undergoing development and are not yet fully functional or available for use. Developers should note that these endpoints are being actively worked on and may become available in the near future as development progresses.
The API endpoints consistently adhere to a unified root structure, ensuring clarity and consistency in responses. This structure comprises three key elements:
We maintain two distinct environments to ensure efficient development, testing, and deployment processes
Our staging environment is dedicated to development and testing purposes. Here, developers can safely experiment with new features, updates, and configurations before they are deployed to the production environment. It serves as a sandbox environment where changes can be thoroughly evaluated and refined, minimizing the risk of disrupting live services. The following list contains crucial information pertaining to our environments. It includes essential details such as configuration settings, access credentials, and deployment instructions.
Our production environment is where the finalized, tested features and updates are deployed for public use. This environment hosts the live version of our API and services, ensuring stability, reliability, and optimal performance for our users. Changes introduced to the production environment undergo rigorous testing and validation in the staging environment to maintain the highest standards of quality and integrity. The following list contains crucial information pertaining to our environments. It includes essential details such as configuration settings, access credentials, and deployment instructions.
To access certain endpoints within our API, an API token must be included in the request header under the 'X-Api-Token' key. This token serves as authentication, allowing access to restricted endpoints and ensuring the security of the data being transmitted. Developers need to ensure that the API token is included in each request to these endpoints to authenticate their access and successfully interact with our system
Some endpoints within our API require an active user account within Neatcar. Access to these endpoints is granted through authentication using a user token, which must be generated via the generate user token endpoint for accounts previously created through the Create Account endpoint. The token must be included in the request header using the format "Authorization: tok_123abc". Token duration is configured individually for each reseller. Endpoints that require a user token are strictly scoped to the authenticated user, ensuring that actions such as saving a credit card or listing carwash history only apply to and return data for the user associated with the token.
You can start utilizing our API right away to access a range of carwash functionalities and data! For immediate access to our open endpoints, simply refer to our documentation and begin integrating with ease.
If you require access to our locked endpoints or would like to obtain an API token for enhanced functionality, please don't hesitate to reach out to us. Our team is here to assist you in getting started and ensuring a smooth integration process.
Feel free to contact us to request an API token or for any further assistance. We're excited to support you in leveraging the full potential of our carwash API for your needs!