Skip to main content

Key Concepts

Before integrating the API, it helps to understand how the system is structured.

Station​

A station is the physical hardware unit installed on-site. It connects to the Follow Rent platform via MQTT and reports its status (battery voltage, connectivity) in real time.

Each station is identified by a unique station token provided to you during setup. This token is used in all API requests to target a specific station.

A station can be either:

  • Online — actively connected, ready to receive commands
  • Offline — not currently reachable (commands will not be delivered until it reconnects)

Lock​

Each station contains one or more locks — individual door or slot mechanisms that can be monitored and controlled remotely. Locks are numbered starting from 1 within their station.

A lock can be either:

  • Locked — door is closed and secured
  • Unlocked — door is open or can be opened

Locking behavior​

Locks are unlocked remotely via the API, and re-lock automatically when the door is physically closed. A sensor on the station detects the door closing and triggers the lock. There is no API endpoint to lock a door — locking is handled entirely by the hardware.

How it fits together​

Your application  →  Follow Rent API  →  Station (on-site)
                                            ├── Lock 1
                                            ├── Lock 2
                                            └── Lock 3
  1. Your application sends requests to the Follow Rent API
  2. The API dispatches commands to the station over MQTT
  3. The station executes the command on the target lock
  4. Status updates flow back to the API in real time

Typical integration flow​

  1. Monitor — Periodically check station status to ensure it's online and battery is healthy
  2. Act — Send unlock commands when your users need to open a door
  3. Verify — Poll the lock status to confirm the action was executed

Important notes​

  • Commands are asynchronous — a successful API response means the command was sent, not that the lock has physically opened. Poll the lock status to confirm.
  • Offline stations — if a station is offline, unlock commands cannot be delivered. Always check station status before sending commands.
  • Battery monitoring — a healthy station typically reports 12V or above. Low voltage may indicate the station needs maintenance.