Theme
Open Clevibox lockers from your own app
Your members open their locker from the app that they already use. You add two parts to your product: a few calls from your server, and a headless SDK in your app. The SDK shows no screen, so the whole experience stays yours.
How one opening works
- Your member taps Open in your app. Your app asks your own server, as it does for any other feature.
- Your server asks Clevibox for a grant. It calls the integration API with your secret API key. A grant is a short text that opens one compartment, once, within 2 minutes.
- Your app hands the grant to the SDK. The SDK finds the lock over Bluetooth and opens the door.
- Your app gets the result. It is
opened,cancelledorfailedwith an error code.
Your API key never leaves your server. Your code never sees a secret of a lock.
What you build
| Part | Runs on | What it does |
|---|---|---|
| Server calls | Your server | Claims a compartment for a member, gets a grant for each opening, and releases the compartment at the end. |
| SDK | Your Android, iOS or React Native app | Opens the door with a grant, and reads the state of the latch. |
Start here
- Integration guide The steps from a test API key to a member who opens a locker: your server, your app on Android, iOS or React Native, and your clubs.
- API reference Every call of the integration API, with its fields, replies and error codes.
Before the first release
The SDK is not in the public package registries yet. Until then, Clevibox sends you the SDK files, the samples and a test API key.
