This guide will assist you in quickly integrating your application with the CleanTrak Controller via API. Alternatively, you can copy this guide into your preferred GPT coding tool and let it complete the work for you [LLMS.txt].

Step 1: Overview

CleanTrak API offers RESTful endpoints for managing car washes, retrieving controller states, generating reports on washed cars, and accessing various statistics. Due to the nature of the carwash business and the need to operate during temporary internet outages, we provide two API endpoints: one for local use and another for cloud access.

The Local API operates on the CleanTrak controller device and can typically be accessed via your local controller's IP for ex at http://192.168.26.254:5000/swagger/. Its main purpose is to allow you to send a wash command from your local POS system or any other local integration without Internet access.

The Cloud API is available at https://api.cleantrak.com/swagger. It provides robust and detailed information about the current wash queue and wash statistics, without the need to navigate the local network. This API works anywhere.

The MQTT/WS Cloud Broker provides telemetry data such as car positions, relay states, digital input statuses, entrance gate states, and car queue updates. This information can be delivered almost instantly, with a latency of less than 250 milliseconds. Although the telemetry format is binary, we are happy to share the details with you upon request. Most workflows can be managed using a simple REST API. However, we understand that you may want to go beyond the basics to achieve seamless data updates in your solution. So do not hesitate to ask.

Step 2: Prerequisites and Integration API token

Token: Bearer 0XjexwvGsRUV4qDI3CHZEnLmAeaIQE1hkU-8kpx8mKiPn7Ru7MB0MilVmYaCVJ8FEaU

X-Company-UIID: c2439d29-7748-471f-81f0-3b1349dd185a

X-Tunnel-UUID: e1a8bb67-8bd8-455c-9bda-570e2b7a6997

P.S. The token is for API validation only and will not work on production locations.

To obtain your own Integration API token, please contact us via https://www.cleantrak.com/
In the future, we will add the ability to generate the Integration API token directly at https://admin.cleantrak.com/. For your convenience, the lifetime of the Integration API token is set to 10 years. However, it could be terminated immediately on your request. Integration API token works on both Local and Cloud API.

For requests to the Local API, use the specific IP address of the controller. You can find the correct IP for your device on the Wash Hub Admin page.

One last thing

We have a functional web App sample: https://github.com/CleanTrak/WashFlowTestApp Feel free to use it to speed up development.
Have a great integration!

Cheers!
CleanTrak Team