Versions Compared

Key

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

Enable the API

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

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

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.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

Method

URL

POST

{{

authurl

auth_url}}token

Body Payload

Code Block
{
    "orgid":[
customer org id
[orgID]],
    "secret":[
private
[auth_
key
secret]]
}

Response

Status

Response

200

Code Block
languagenone
{
  "accesstoken": 
<token>
[[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.