Web Services
ClubExpress plans to offer a full suite of API functions, to allow outside developers to create applications that can access data for a specific club or association.
The first of these functions is a membership verification web service. This function can be used to verify whether someone is an active member of the club or association, based on either their username and password, or their email address and first name.
Activation: The one-time fee to activate this module for your website is $200.
The base url to access the service is: https://ws.clubexpress.com/member_status.ashx?cid=<CLUB_ID>&key=<KEY>
CLUB_ID is a “club_id”, an internal value.
KEY is a unique value, also internal, that we generate for you.
To this url, you will add the parameters needed for the lookup. These can be either a user name ('&u') AND password ('&p’); or an email address ('&e') AND first name ('&f'); or an email address ('&e) AND member number ('&n'). So, for example, to look yourself up by email and first name, you would add the following to the base URL
'&e=<EMAIL_ADDRESS>&f=<FIRST_NAME>’
The web service will return a single number. This number represents either the status of the matched member, or an error code. (Some of these status codes will not apply to a specific club's membership, but here is the complete list, just in case.) The possible results are:
1 = active member found
2 = expired member found
3 = dropped member
5 = frozen member
6 = bulk loaded member
7 = pending member
8 = prospective member
10 = trial member
0 = internal error occurred (ClubExpress problem)
-1 = more than one match found (applies to email lookup only - see note below)
-2 = no match found
-3 = invalid request (user name without password, or email without first name)
When we do lookups by user name and password, there can be at most one matching member. When we match by email and first name, it is possible that multiple members will match. If all matching members have the same status, we will return that status. If they are different, we will return the -1 code.
The usage rules are:
- Only GET requests (no POST).
- Only HTTPS (SSL) requests (no HTTP)
- If the request does not use HTTPS, or if it is missing the 'CLUB_ID' or ‘KEY' parameters, or if they don't match, you will receive an http 'Not Authorized' error (403)
- A POST request will result in a 404 error.
- All parameters must be url encoded (note the encoding in the key value, and the email address in the samples).
- We must receive either a user name and password, or an email and first name. Otherwise, we will return the invalid request code (-3).
- If you supply more parameters than required, we will ignore the extras. If both user name and password are supplied, we will use them and ignore any email and first name that are sent.
If you receive an internal error code (0), we get an email from the system so we know there is a problem.
A file is created once per day (replacing the previous day's file) and is accessible at a URL provided (but not linked anywhere on your website).
The file contains the following fields for each Active member in your database:
- First Name
- Last Name
- Middle Initial
- Spouse First Name
- Member Number
- Address1
- Address2
- City
- State
- Zip
- Latitude
- Longitude
- Phone
- Mobile Phone
- Email Address
- Member ID
Note: Not member number; the Member ID is used to link to the member's profile.
- Photo File Name
- Member Type
Note: You must notify us if you wish to use the JSON file so we can perform a few steps manually on our end.