Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Enable the API

The membes API incurs a setup and ongoing fee (provided on request), the customer can request access by logging a ticket in the Help Desk or emailing support@membes.com.au.

Authorisation & Access URLs

The API EndPoints can be accessed via the following URLs:

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

Access URL: https://[customer-membes-url]/api

The Authorisation URL used is referred to as {{authurl}} throughout this document.

The Access URL used is referred to as {{url}} throughout this document.

Access Token

Almost all API endpoints will need to include a bearer token as part of the API authentication framework.

To call the token endpoint, you will need to obtain the private_key.

The customer can request the private_key via the Help Desk or developers can email a request to support@membes.com.au.

Request

Method

URL

POST

{{authurl}}/token

Body Payload

Code Block
{
    "orgid":[customer org id],
    "secret":[private_key]
}

Response

Status

Response

200

Code Block
languagenone
{
  "accesstoken": <token>
}

Endpoints

Endpoints documentation can be found at https://documenter.getpostman.com/view/9582776/TzzDKahF .

Conventions

  • Status - HTTP status code of response

  • All responses are in JSON format.

  • All request parameters are mandatory unless explicitly marked as *-optional.