Skip to main content

Getting Started

Get from zero to your first unlock in 3 API calls.

Prerequisites​

  • Your account credentials (email + password), provided by the Follow Rent team
  • Your station token, provided during hardware installation
  • A tool to make HTTP requests (cURL, Postman, or your application code)

Base URL​

All API requests are made to:

https://api.follow-rent.com

Step 1 — Authenticate​

curl -X POST https://api.follow-rent.com/v1/auth/login \
  -H "Content-Type: application/json" \
  -d '{"email": "your@email.com", "password": "your-password"}'

Response:

{
  "accessToken": "eyJhbGciOiJIUzI1NiIs...",
  "refreshToken": "550e8400-e29b-41d4-a716-446655440000"
}

Save both tokens. The access token is used in every subsequent request. The refresh token is used to get a new access token when the current one expires.

Step 2 — Check your station​

Verify your station is online and reachable:

curl https://api.follow-rent.com/v1/stations/YOUR_STATION_TOKEN \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "station_id": 123,
  "battery_voltage": 12.5,
  "last_connection": "2024-04-25T10:30:00Z",
  "status": "online",
  "locks": [
    {
      "lock_id": "lock-1",
      "status": "locked",
      "last_updated": "2024-04-25T10:30:00Z"
    }
  ]
}

Check that status is "online" before sending commands.

Step 3 — Unlock a door​

curl -X POST https://api.follow-rent.com/v1/stations/YOUR_STATION_TOKEN/locks/1/unlock \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Response:

{
  "status": "success"
}

The unlock command is sent to the station over MQTT. The lock will physically open within a few seconds depending on network conditions.

What's next?​