API Availability in Mavim – Retrieving Data Programmatically
Mavim offers two ways to retrieve data programmatically via an API
1. Mavim Portal API
The Mavim Portal includes a built-in API that supports basic authentication.
Steps to enable:
- Log in as Admin.
- Go to the General tab.
- Enable API Basic Auth.
- Set a username and password.
Once enabled, you can access the API using these credentials.
The API is documented online at:
https://<your-mavim-portal-url>/odata/swagger
This documentation provides:
- A full overview of available endpoints.
- Usage examples.
- Technical specifications.
2. Mavim iMprove API
For advanced integrations, Mavim offers the iMprove API, built on the OpenAPI (Swagger) standard.
It includes a document API based on the WOPI protocol, used by Microsoft for Office web access.
Authentication:
- Uses OAuth2 via Azure AD.
- Hosted in Microsoft Azure API Management.
Developer Portal:
This portal contains all necessary documentation and onboarding instructions.
Requirements for Using the iMprove API:
- Access to the Mavim API Developer Portal (invitation required).
- Basic knowledge of REST APIs and tools like Postman or Insomnia.
- Client ID, secret, and configuration values (provided confidentially by Mavim).
- User must be onboarded by an iMprove Application Global Administrator via Mavim Connect Center.
- User must be assigned to one or more databases.
- Appropriate permissions must be granted to access content at the root or repository level.
For more details, refer to the official help documentation:
https://docs.mavimcloud.com/ (search for API).