Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Version History

« Previous Version 7 Next »

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

Method

URL

POST

{{auth_url}}token

Body Payload

{
    "orgid":[[orgID]],
    "secret":[[auth_secret]]
}

Response

Status

Response

200

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

  • No labels