logo

MemberCentral API
A RESTful API for MemberCentral

master:7190667395:2018-07-06 20:42 GMT

To access your association data using the MemberCentral API, contact support@membercentral.com.

Base URL and HTTPS Requirement

Use these base URLs to access the MemberCentral API:

  • http://apibeta.membercentral.com for access to your beta site
  • https://api.membercentral.com for access to your production site

HTTPS connections must be used when accessing the API in the PRODUCTION environment. Connecting via HTTP will result in the following response:

403 Forbidden
	
{
    "data": {},
    "error": true,
    "messages": [
        "Forbidden: SSL Required. Endpoints must be called over https"
    ]
}

/authenticate

POST - Returns an API token from your API credentials. API tokens expire 30 minutes after they are generated.

Required Request Headers

content-type: application/json

Methods

GET
not applicable
POST
/v1/authenticate
PUT
not applicable
DELETE
not applicable

/authenticate/me

GET - Returns an API token expiration date for your API Token.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/authenticate/me
POST
not applicable
PUT
not applicable
DELETE
not applicable

/login

POST - Returns an serialized login link from a website username and password. Login links expire 5 minutes after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

content-type: application/json

Methods

GET
not applicable
POST
/v1/login
PUT
not applicable
DELETE
not applicable

/member

GET - Returns member records
POST - Creates a member record
PUT - Updates a member record
DELETE - Deletes a member record

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member
GET
/v1/member/{membernumber}
POST
/v1/member
PUT
/v1/member/{membernumber}
DELETE
/v1/member/{membernumber}

/member/email

GET - Returns the member's email addresses
PUT - Updates a member's email address

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/email
GET
/v1/member/{membernumber}/email/{type}
POST
not applicable
PUT
/v1/member/{membernumber}/email/{type}
DELETE
not applicable

/member/group

GET - Returns the member's group assignments

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/group
GET
/v1/member/{membernumber}/group/{groupcode}
POST
not applicable
PUT
not applicable
DELETE
not applicable

/member/loginurl

POST - Returns an serialized login link for a membernumber. Login links expire 5 minutes after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
not applicable
POST
/v1/member/{membernumber}/loginurl
PUT
not applicable
DELETE
not applicable

/member/sso/zendesk

POST - Returns an serialized Zendesk link for a membernumber. Zendesk links expire 3 minutes after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
not applicable
POST
/v1/member/{membernumber}/sso/zendesk
PUT
not applicable
DELETE
not applicable

/member/sso/zendesk/webwidgetjwt

POST - Returns an JWT for Zendesk's Web Widget for a membernumber. Zendesk WebWidget JWTs expire 2 hours after they are generated.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
not applicable
POST
/v1/member/{membernumber}/sso/zendesk/webwidgetjwt
PUT
not applicable
DELETE
not applicable

/member/website

GET - Returns the member's website addresses
PUT - Updates a member's website address

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/website
GET
/v1/member/{membernumber}/website/{type}
POST
not applicable
PUT
/v1/member/{membernumber}/website/{type}
DELETE
not applicable

/memberupdate

GET - Returns the possible keys/columns to use when adding or updating member records.
POST - Upload a member file to add/update multiple member records.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/memberupdate
POST
/v1/memberupdate
PUT
not applicable
DELETE
not applicable