🚧
Exchange API Deprecation Notice
The Exchange API is a realtime authentication method that requires the cloud and connectivity to be fully intact during the key exchange. This module predates and by its nature cannot support our offline key exchange capability. With Offline Mode, the MS5 and MS4 SmartBoxes can continue operating even when connectivity is lost or the cloud is disrupted by reverting to their last synced state, enhancing reliability and ensuring a seamless key exchange experience. Thus, we strongly encourage using Accesses and Permissions for development which sync with the SmartBox in advance of the key exchange. A seamless user experience can be implemented by presenting a QR code for the user to present at the SmartBox.
For more details on Offline Mode, visit our help center.

Using Exchange for Mobile Key Exchange

While most API users find the booking code and check-in link provided after creating an access sufficient, you may choose to directly integrate mobile key exchanges into your native application using the Exchange object.

Key points for using the Exchange object:

Ownership Requirement: You can only perform exchanges with SmartBoxes or keys that you own within the public network.
Workflow: Initiate a pickup or drop-off by creating an Exchange object. You can retrieve individual exchanges or list all exchanges associated with your account.
Data Provided: Each Exchange object contains:
- The current status of the exchange (e.g., completed, in progress).
- Information about the associated key and user.
- Error codes if the exchange operation fails.

Exchange workflows are available via the RESTful endpoint:
https://www.keycafe.com/v0/exchange

Important Note on Legacy Locations

The Exchange API only supports locations where the legacy flag is set to false.
If you attempt an exchange via the API at a legacy location, the following error will be returned: exchange.location.legacy