What is the Rimo3 API?
The Rimo3 API is a collection of endpoints that can perform the same functions presented in the Rimo3 web portal Graphical User Interface (GUI). Whether developer or non-developer, you can use these endpoints to create customized processes or integrate into existing processes where human interaction is not required.
For example, you could create a Rimo3 integration into an application update process. The process would be triggered via the Rimo3 API that onboards and tests the new application update against your Windows OS.
Another example would be that there is a Windows OS update that you need to deploy, and you want to automate the testing of your applications against the update before deploying.
Leverage Your Application Automation with Rimo3
Application Lifecycle Management (ALM) can be extremely time consuming for organizations with complex environments and a high number Windows applications. By leveraging automation, organizations can make significant savings to time and thus cost, but also reduce risk and complexity. At Rimo3 we pride ourselves on applying automation to the complexity of ALM thus enabling you to transform traditional rollout project activities to simply being a day-to-day activity.
Create an API user
-
In your workspace navigate to Extend Menu → Integrations, and select API Accounts
or browse to: https://rimo3cloud.com/PublicApiAccounts/Index - Click on Add API Account to generate a new set of API Credentials
- Use the eye icon to view the client secret, and the copy icons to copy both the Client ID and Client Secret to be stored before saving the new credentials.
- After clicking Save you will still be able to copy the Client Secret, but once you click on close you will not be able to retrieve the Client Secret anymore.
Obtain an Access Token
To request a new access token Post a call to the new token url with the following details:
- URL:
https://rimo3cloud.com/api/v2/connect/token
- Method:
POST - Header:
"Authorization" = Basic <Base64EncodedCredentials>
Where <Base64EncodedCredentials> is a Base64 encoded string of the API Client ID and Client Secret created above, in the following format: <clientId>:<clientSecret> - Body (formatted as JSON):
Form-Data: 'grant_type=client_credentials'
The response will include the access token, token type and expiration time (seconds) in JSON format:{ "access_token": "<your_access_token>", "token_type": "Bearer", "expires_in": 3600}
Continue to use the access token in API calls by including it in the Header as follows:
"Authorization" = Bearer <access_token>
Where <access_token> is from the previous token request'
Testing the access token
Access tokens can be tested using the following new endpoint:
- URL:
https://rimo3cloud.com/api/v2/connect/test - Method:
GET - Header:
"Authorization" = Bearer <access token>