APIs usage

Memority is a full API platform and offers various type of APIs to manage the solution.

These APIs are requested through Memority API Guard services which will control authentication (OAuth2 Client credentials or OAuth2 Authorization code) and authorization for the authenticated users. Authorization to request APIs are directly manage in portal.

There are 3 types of APIs:

Data: to manage objects
Features: to execute features
Configuration: to import and export microservices configurations

Memority APIs available through API Guard

Postman collection

Memority provides Postman collections and environment templates to request APIs.

Setup

	Action	Description
1	Download the Postman collection and environment templates	Memority APIs.postman_collection.json Template CSTAGE.postman_environment.json Template CPROD.postman_environment.json
2	On Postman, import the collection and environment templates	Postman import form
3	On Postman, go to “Environments” menu to set the environment for your tenant Right click on one of the template to duplicate it Rename the new environment with your tenant name Set the tenant identifier in memority_tenant_id Save the environment	Postman environment form
4	On your tenant, check that your identity has right “sys.api-zone-access” with the right target. See https://doc.memority.dev/configuration-guide/latest/api-guardian-guide to get existing API zones. By default, My Administrator identities has the right with target “*” to have access to any API zones.	My Administrator role configuration

Usage

Action

Description

1

On Postman, select the environment of the tenant you want to request on.

2

On Postman, authenticate to be able to request APIs

In menu collections, click “Memority APIs”
Go to “Authorization” tab
At the bottom of the page, click “Get New Access Token” to trigger authentication
A popup will appear to authenticate against your tenant
Complete the authentication

Memority APIs authentication requests Multi-Factor authentication

3

On Postman, select an API and click send to execute the request