API integration

Explore, test, and integrate with the APIs using a playground-first approach and OpenAPI-based client generation.

The playground imitates the actual interactions made by your application.

flowchart LR
    A[API Definition] --> B[Playground]
    A --> C[OpenAPI Specification]
    C --> D[Generated API Clients]
    D --> E[Applications]

Explore the API in the playground

The documentation platform provides an interactive playground under API Reference that allows you to explore and invoke the APIs directly in the browser.

The playground is the recommended starting point and can be used to:

Discover available endpoints and operations
Inspect request and response payloads
Understand validation rules and error responses
Test authentication and permissions
Experiment safely in a sandbox environment

No local setup or tooling is required.

flowchart LR
A[Explore API in Playground] --> B[Inspect requests and responses] --> C[Review OpenAPI specification]

From playground to implementation

Once you are familiar with API behavior using the playground, implementation should be based on the OpenAPI specification, which serves as the authoritative contract.

The playground and the OpenAPI specification are generated from the same underlying API definition, ensuring consistent behavior.

flowchart LR
D[Generate API client] --> E[Configure authentication] --> F[Implement and test integration]

Environments

The APIs are available in multiple environments, each intended for a specific stage of development, testing, or production use.

Environment	Description	Who should use this	Base URL
Production	Live production environment used for real traffic and business transactions.	End users and partners running live integrations in production.	`https://mapi-<region>.unimaze.com`
Sandbox	Public sandbox environment used for development, experimentation, and onboarding. Includes an interactive playground for API exploration.	All partners during development, onboarding, and initial testing.	`https://mapi-sandbox.unimaze.com`
UAT	User Acceptance Testing environment used for validation of release and hotfix candidates.	Selected partners participating in release or hotfix validation for a limited period of time.	`https://mapi-uat.unimaze.com`
QA Proxy	Quality assurance proxy environment used for testing specific features while they are still under development.	Selected partners working together with Unimaze on new or in-development features, for a limited period of time.	`https://mapi-qa-proxy.unimaze.com`

Access to the UAT and QA Proxy environments is granted on a temporary basis and only for specific collaboration scenarios. Credentials and availability are provided by Unimaze as needed.

OpenAPI specification (sandbox)

Use the following OpenAPI definition when generating clients against the sandbox environment:

https://mapi-sandbox.unimaze.com/swagger/v1/swagger.json

Continue with implementation

Use the navigation menu to select your programming language and continue with client generation and authentication setup.