Below are the methods that are included with the Higher Logic API bridge.
| API Method | Role for Integration/SSO |
|---|---|
| AUTHENTICATE | Used in the Higher Logic iMIS SSO. This will check to see if the GUID exists and is mapped to a valid iMIS ID. |
| AUTHENTICATEUSER | Used in the MemberCentric authentication. This method will check a username and password combination utilizing ASI’s libraries. |
| AUTHENTICATEUSERID | Used to decrypt a UserID taking advantage of ASI cryptography libraries. |
| AUTHORIZE | Used in the Higher Logic iMIS SSO. This will create new mapping of a new GUID to an iMIS member key. Works together with the Authenticate method. |
| GETCHANGEDMEMBERS | Used in the Periodic Refresh. Accesses the SQL database and executes the hlGetChangedMembers stored procedure. |
| GETCOMMUNITYGROUPMEMBERS | Helper method used to extract all the members in a community. |
| GETEVENTS | Used in the Events Refresh. Accesses the SQL database and executes a query to extract all future events from iMIS’s events module. |
| GETIDFROMEMAILADDRESS | Used to convert email addresses to iMIS IDs. |
| GETLOOKUPDATA | Used in the Member Refresh. An additional data source for custom demographics if user defined tables aren’t located within the database. |
| GETMEMBERCOMMUNITYGROUPS | Used in the Member Refresh. Accesses the SQL database and executes the hlGetMemberCommunityGroups stored procedure to extract all the communities for the user. |
| GETMEMBERDETAILS | Used in the Member Refresh. Accesses the SQL database and executes the hlGetChangedMembers stored procedure to extract all the basic person demographics belonging to the user. |
| GETMEMBERSECURITYGROUPS | Used in the Member Refresh. Accesses the SQL database and executes the hlGetMemberSecurityGroups stored procedure to extract all the security groups for a user. |
| GETSECURITYGROUPMEMBERS | Helper method used to extract all the members in a security group. |
| GETSECURITYGROUPS | Helper method used to extract all security groups. |
| GETSECURITYGROUPS | Used in the Member Refresh. This method extracts all user defined demographics specified in the integration. |
| GETUSERDEFINEDMETA | Used in the Member Refresh. This method determines the schema and any data constraints for the custom demographics specified in the integration. This information will be used by GetUserDefinedData when parsing demographic information. |
| PING | Just returns 0 to see how long a round trip takes. |
| SETMEMBERDETAILS | This method has been deprecated and is not used in the integration. |
| WRITEACTIVITYDETAILS | Used in Activity Sync. This method executes the hlWriteActivity stored procedure to insert activities in the iMIS database. |
WriteActivityDetails
This method is connected to the stored procedure, hlWriteActivity. Each activity contains the following information for iMIS.
| Parameter | Activity Sync use |
|---|---|
| MEMBERKEY | The unique identifier of the person who has created the activity on Higher Logic. |
| ACTIVITYDATE | The date of the activity when it was created. |
| ACTIVITYTYPE | This is the iMIS category/activity code. This value maps to the specific activity type that was created which will describe the action and where it was triggered. |
| DESCRIPTION | The full activity description which will disclose any other information that is relevant. This is based on each activity category. |
If not exists (select * from product_type where prod_type = 'iBadEmail')
begin
INSERT INTO PRODUCT_TYPE(PROD_TYPE, DESCRIPTION, DESCRIPTION_PROMPT, CREATE_HISTORY_TAB, HISTORY_TAB_TITLE)
VALUES ('iBadEmail', 'Continuous Bounces in Informz', 'E-mail Address', 1, 'Informz Bad Emails')
End
Related articles
The following articles have supporting information for the iMIS integration.