Enable the API

The Membes API incurs a setup and ongoing fee (see Membes pricing schedule), the customer can request access by logging a ticket in the Help Desk.

Authorisation - Access URLs and Keys needed

API endpoints can be accessed via the following URLs:

• Authorisation URL: https://ms-auth.membes-ams.com/

  • referred to as {{auth_url}} throughout this document.

• API URL: https://[customer-membes-url]/api/

  • referred to as {{api_url}} throughout this document.

The following keys will need to be obtained from Membes

• Organisational ID

  • referred to as [[orgID]] in this document.

• Authentication Secret

  • referred to as [[auth_secret]] in this document.

Obtain Access Token

An Access Token, referred to as [[token]] in this documentation, will need to be included as a "bearer" Header in API calls.

The Access token is valid for 5 minutes from the time it is received.

Request

Response

Endpoints

Endpoints documentation can be found at membes API v2 .

Conventions

• Status - HTTP status code of response

• All responses are in JSON format.