In this article, we will go through RICOH Spaces Open API.
What it is
The RICOH Spaces Open API enables businesses to expand on the current functionality of RICOH Spaces by either taking out data and executing external processes, or pushing data in from external processes. This takes away the reliance of the RICOH Spaces product team to build integrations and allows companies to build what they want. Some examples of functionality that can be built using the Open API are:
Post IoT data to RICOH Spaces to enable the ingestion of IoT data from devices that RICOH Spaces doesn’t support.
Pull booking data from RICOH Spaces and send it to an external booking tool such as a parking barrier.
Pull visit data from RICOH Spaces and send to an external entry barrier tool.
All currently functionality of the RICOH Spaces API can be found at https://eu-cloud.ricohspaces.app/documentation
How to Set It Up
Before any custom functionality can be developed an API Key must first be created. This can be done via the Organisation area of RICOH Spaces and can only be created by a Global Admin. The API key can be given a name and can be enabled or disabled. The API key can only be seen once during the creation process, after which it can never be obtained again. If the API key is lost, a new one would need to be created.
Once this has been created the API can be interacted with. Prior to any data push or pull an Auth token must be created. This can be done by authenticating below.
Authentication
Before using the Open API, authentication is required to obtain an access token. This is done by calling the /auth/token endpoint with the API Key obtained from RICOH Spaces and a Client ID which can be provided by RICOH Spaces support.
Endpoint: POST /auth/token
Headers:
api-key: Your API Key
client-id: Your Client ID
Response: A JWT token with a 1-hour expiry.
Usage: The token must be included in the Authorization header as a Bearer token for all subsequent API requests.
The API response contains a JWT token which can be used alongside the Client ID to perform all future API calls.
Validating
Once you are authenticated and using the Open API endpoints you can validate that your API calls are working in two ways.
Receiving successful responses and data.
All valid responses should return a 200 status code and the data structure defined within the Open API Documentation.
2. Reviewing the activity log in RICOH Spaces.
The API Key activity can be viewed from the API Keys page, it shows logs of the API calls executed, the time and date and the IP Address the call came from.