⚛️ Overview

<aside> <img src="/icons/science_blue.svg" alt="/icons/science_blue.svg" width="40px" /> Make CM platform more sticky to your company's maturity level and make it part of your tech ecosystem.

When platform capabilities are not enough for your cases, you can start using more powerful tools to connect the dots with your app's ecosystems or even automate the work of the platform with the help of our API.

</aside>

Benefits of using API

• Automate manual processes and optimise workflows by providing the ability to integrate your digital ecosystem directly with CM.
• API will help to extend platform capabilities, customise solutions and reduce maintenance costs
• API allows you to leverage the enterprise’s assets while building out the customisations they require in weeks or months, not years.

API Audience

1. Solution Owners - can leverage the API to solve different use cases, driving business results
2. Developers - can define what business blocks (API Endpoints) to solve use cases highlighted by Solution Owners
3. End users - get new capabilities from the platform

⛳️ What you can do with CM API

API is a set of building blocks that your development team can use to retrieve data from the platform or input data into CM.

Examples of Use Cases

<aside> <img src="/icons/groups_blue.svg" alt="/icons/groups_blue.svg" width="40px" /> USER and ACCESS management

Automatically manage a list of users and assign appropriate roles at both the platform and document levels based on HR metadata. This ensures that employees who change roles or departments or join or leave the company will have automatic access to CM with the relevant permissions and information.

Use cases

1. Develop a seamless integration to effectively manage your users’ onboarding, off-boarding and change processes based on the data in your HR tools.
   1. Create, Update, Disable and add users to required groups
   2. Update or provide additional information about users' departments, job functions, and more to enhance context for other users and maintain personalised experiences.
   3. Create Groups to maintain access levels
   4. Manage Platform level access
   5. Manage Document-level access

API Capabilities

• Bulk create/update/delete/disable users
• Bulk management of user’s Metadata and User Groups
• Extract all users’ information
• Set platform and document permissions
• Extract Groups details </aside>

<aside> <img src="/icons/document_green.svg" alt="/icons/document_green.svg" width="40px" /> EXTEND CM with Controls, Regulations and other Document types

Provide access to read-only documents such as controls, regulations, risks, etc., to enrich your workflows with required data and help your users easily access the right context when needed.

Use cases

• Integrate your data from Risks, Controls and Regulations management systems and keep it up-to-date
• Manage your document hierarchy and connections between your documents
• Transition to our platform from other services.

API Capabilities

• Create documents
• Manage Document metadata
• Update Document metadata
• Create/Update/Delete document paragraphs
• View/Create/Update connections </aside>

<aside> <img src="/icons/science_pink.svg" alt="/icons/science_pink.svg" width="40px" /> AUTOMATE platform

Trigger actions in other systems when events occur on CM or perform actions within CM when events happen inside or outside the platform.

Use cases

• Enhance platform capabilities and create a new user experience. For example, store assessment scores from your LMS tools as metadata to provide users with valuable insights
• Integrate with communication tools within your digital ecosystem to notify users about some important changes on the platform
• Update other systems with the latest information when a new version of the document is released on CM
• Automatically publish documents on CM or update their metadata triggered by events in other tools.

API Capabilities

• Extract documents and their metadata
• Search for documents based on queries and filters
• Extract document activities
• Change document metadata
• Change document stage </aside>

<aside> <img src="/icons/search_gray.svg" alt="/icons/search_gray.svg" width="40px" /> AUDIT & INSIGHTS

Monitor platform activities to ensure data consistency, gather evidence, and control data quality.

Use cases

1. Access monitoring:
   1. Gain visibility into user documents and platform permissions to analyse their permission levels.
   2. Review specific user activities and access levels to identify gaps or issues.
2. Data consistency monitoring: Gain insight into document metadata, document status, and progress of approvals.
3. Evidence collection: Get insight on who does what and when in the documents to define potential gaps

API Capabilities

• Extract documents and their metadata
• Extract document activities
• Extract user’s document-level permissions </aside>

<aside> <img src="/icons/kind_gray.svg" alt="/icons/kind_gray.svg" width="40px" /> ASSETS management

</aside>

<aside> <img src="/icons/chart-mixed_gray.svg" alt="/icons/chart-mixed_gray.svg" width="40px" /> REPORTING and TRACKING Efficiency

</aside>

🏗️  How to implement

1. Purchases CM API module
2. 🚀 Your developers can start building solutions based on CM API documentation: https://pm-api-docs.corlytics.com/

🔥  Important

1. API Version Support: We only support one version of the API. Developers have one quarter until the next release to implement the necessary changes for the latest API version.
2. Access to API: Refresh Token is valid only for a limited time: 30 days / configurable - could up to 1 year. Our team will then send a new “Refresh token”
3. API Usage:

<aside> <img src="/icons/code_pink.svg" alt="/icons/code_pink.svg" width="40px" />

</aside>