RCMS OpenAPI lets an external system use supported RCMS API operations. Create a client to obtain the credentials needed for an integration, and use the API manual to find the available operations.
Before you begin: Sign in to the correct RCMS company account with access to OpenAPI. Choose a name that identifies the integration and keep its credentials secure.
Create an API client
- Select Support in the top navigation, then select OpenAPI.
- Select CREATE.
- Enter a descriptive client name, for example Acme Integration.
- Select GENERATE. RCMS displays a client ID after the API key is generated.
- Close the confirmation and check the client list for the new entry.
Warning: Treat the API key as a secret. Share it only with authorised people and systems; do not include it in screenshots or public documentation.
Open the API documentation
On the OpenAPI page, select API MANUAL to view the API reference and available operations. Use the reference when building your integration.