ACTIVEWorks Consumer Category API Contract

Organizations can restrict consumers’ access to events and categories based on unique rules. Those rules are controlled by organizations and are held in a database that is stored outside of ACTIVEWorks. This solution allows organizations to create a query connection between their 3rd-party database and the ACTIVEWorks registration form that will allow or prohibit a consumer from registering.

1. An organization provides a consumer category API in ACTIVEWorks > Settings > Account settings > Price type restrictions.
2. ACTIVEWorks can then send a payload that contains a participant’s email, first name, last name and date-of-birth to the API provided by the organization.
3. The organization uses the data from the payload to query the participant in organization’s database and then responses ACTIVEWorks back with the category ID to which the participant belongs.

Consumer category API contract format:

path: /api/categories
method: POST
Authentication Head: Authorization: Bearer xxxxxxxxxxxx
payload:
{
    "email":"ACTIVE.Test@active.com", 
    "firstName":"ACTIVE",
    "lastName":"Test",
    "dob":"1990-01-01" //may be null
}

response:
["0001", "0002", "0003", "0004" //a list of consumer category ids which the customer belongs to]

Check API connection: 
After the organization provides the consumer category API URL and authentication KEY/TOKEN in ACTIVEWorks, organization could check the API connection:
1. Input a request into the Request body section, for example:
{
"email":""
"firstname":"",
"lastname":"",
"dob":"2000-01-01"
}
2. Click Check api button, the response body will be displayed and a flag either "Failed" or "Success" to indicate the connection status.