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.

Access URL

The API EndPoints can be accessed via one of the following URLs:

Access URL: api.membes.com.au

The Access URL used is referred to as [access-url] throughout this document.

Authentication

Authentication is completed using the OAuth 2.0 Protocol (http://oauth.net/2).

To complete authentication, you will need to obtain the client_id and client_secret API keys.

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

Request

Response

{
  "TOKEN": <token>,
  "STATUS": true | false
}

status (boolean) - true if authentication was successful, false if failed
token (string) - all further API calls must have this token passed in as a parameter    

End points

End point documentation can be found at http://apidocs.membes.com.au.

Conventions

• Client - Client application

• Status - HTTP status code of response

• All the possible responses are listed under “responses” for each method. Only one of them is issued per request server.

• All responses are in JSON format.

• All request parameters are mandatory unless explicitly marked as [optional].

• The type of values accepted for a request parameter are shown the values column like this [10|<any number>]. The | symbol means OR. If the parameter is [optional], the default value is shown in blue bold text as 10 is written in [10|<any number>].