logo

MemberCentral API
A RESTful API for MemberCentral

master:cb25559a0e:2020-08-07 15:27 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"
    ]
}

/address

GET - Returns address types
POST - Creates an address type
PUT - Updates an address type
DELETE - Deletes an address type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/address
GET
/v1/address/{api_id}
POST
/v1/address
PUT
/v1/address/{api_id}
DELETE
/v1/address/{api_id}

/address/tag

GET - Returns address tag types
POST - Creates an address tag type
PUT - Updates an address tag type
DELETE - Deletes an address tag type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/address/tag
GET
/v1/address/tag/{api_id}
POST
/v1/address/tag
PUT
/v1/address/tag/{api_id}
DELETE
/v1/address/tag/{api_id}

/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

/email

GET - Returns email types
POST - Creates an email type
PUT - Updates an email type
DELETE - Deletes an email type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/email
GET
/v1/email/{api_id}
POST
/v1/email
PUT
/v1/email/{api_id}
DELETE
/v1/email/{api_id}

/email/tag

GET - Returns email tag types
POST - Creates an email tag type
PUT - Updates an email tag type
DELETE - Deletes an email tag type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/email/tag
GET
/v1/email/tag/{api_id}
POST
/v1/email/tag
PUT
/v1/email/tag/{api_id}
DELETE
/v1/email/tag/{api_id}

/event

GET - Returns events

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/event
GET
/v1/event/{api_id}
POST
not applicable
PUT
not applicable
DELETE
not applicable

/group

GET - Returns groups
POST - Creates a group
PUT - Updates a group
DELETE - Deletes a group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/group
GET
/v1/group/{api_id}
POST
/v1/group
PUT
/v1/group/{api_id}
DELETE
/v1/group/{api_id}

/group/member

GET - Returns the group's member assignments
PUT - Manually assigns the member to the group
DELETE - Removes a member's manual assignment to the group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

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

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

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/member/credit

GET - Returns the credits earned by the member

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/member/email

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

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/member/event

GET - Returns the member's event registrations

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/event
GET
/v1/member/{membernumber}/event/{api_id}

/member/group

GET - Returns the member's group assignments
PUT - Manually assigns the member to the group
DELETE - Removes a member's manual assignment to the group

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/member/list

GET - Returns the member's list memberships

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/list
GET
/v1/member/{membernumber}/list/{listname}
GET
/v1/member/{membernumber}/list/{listname}/{api_id}
POST
/v1/member/{membernumber}/list/{listname}
PUT
/v1/member/{membernumber}/list/{listname}/{api_id}
DELETE
/v1/member/{membernumber}/list/{listname}/{api_id}

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

GET - Returns the member's photo URI

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/member/sso/mcusertokenjwt

POST - Returns an JWT for MemberCentral's MCUserToken for a membernumber.

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
not applicable
POST
/v1/member/{membernumber}/sso/mcusertokenjwt
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/subscription

GET - Returns the member's subscription
POST - Creates a member's subscription
DELETE - Removes a member's subscription

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/member/{membernumber}/subscription
GET
/v1/member/{membernumber}/subscription/{subscriber_id}
DELETE
/v1/member/{membernumber}/subscription/{subscriber_id}
POST
/v1/member/{membernumber}/subscription

/member/website

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

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

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

/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

/organization/sso/mcusertokensecret

MemberCentral's MCUserToken Secret is used to generate a JSON Web Token (JWT) both in direct calls to /member/{membernumber}/sso/mcusertokenjwt and in post-login redirection when a returnURL is specified.

When linking to a site's login page, there is an option to pass in a returnURL parameter. Upon successful login, we will redirect the user back to that returnURL. If a MCUserToken Secret is defined for the organization, we will pass along a JWT payload, allowing you to parse the JWT using the MCUserToken Secret to obtain the membernumber of the member that just logged in. The structure of the JWT payload is defined in /member/sso/mcusertokenjwt.

Example: If your site directs members to the login page at
http://yourassociation.org/?pg=login&returnURL=https%3A%2F%2Fcle.yourassociation.org%2Fmyaccount
and the MCUserToken Secret is defined, we will redirect the member back to
https://cle.yourassociation.org/myaccount?mcusertoken=XXXX....XXXX

GET - Returns the user token secret key
PUT - Sets the user token secret key
DELETE - Clears the user token secret key

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/organization/sso/mcusertokensecret
POST
not applicable
PUT
/v1/organization/sso/mcusertokensecret
DELETE
/v1/organization/sso/mcusertokensecret

/phone

GET - Returns phone types
POST - Creates a phone type
PUT - Updates a phone type
DELETE - Deletes a phone type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/phone
GET
/v1/phone/{api_id}
POST
/v1/phone
PUT
/v1/phone/{api_id}
DELETE
/v1/phone/{api_id}

/website

GET - Returns website types
POST - Creates a website type
PUT - Updates a website type
DELETE - Deletes a website type

Required Request Headers

Authorization: Bearer YOUR_API_TOKEN

Methods

GET
/v1/website
GET
/v1/website/{api_id}
POST
/v1/website
PUT
/v1/website/{api_id}
DELETE
/v1/website/{api_id}