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.
For most API customers the booking code and check-in link provided after creating an access is sufficient for their needs. However, if you want to rebuild a mobile key exchange experience in your own native app, you can use the Exchange object to directly invoke and communicate with the SmartBoxes you own. Please note that the Exchange object only works with SmartBoxes you own or keys you own in the public network.
To start a pickup or drop-off process, you create an Exchange object. You can retrieve individual exchanges as well as list all exchanges. Exchange objects describe the current state of an exchange operation (whether it’s completed or not), contain information about the key and the user who is performing the exchange, and provide an error code if the operation was not successful.
Exchange workflows are made available via the RESTful endpoint: https://www.keycafe.com/v0/exchange
Note: Only locations for which "legacy" is false support exchange via the API. If an exchange is attempted through the API at a legacy location, the error code "exchange.location.legacy" will be returned.