Integrations and APIs - Database Synchronization APIs


CivicReady
®

Adding Members Using API

Overview

The CivicReady Membership API is an exciting new way to import users into the CivicReady system.

Using the CivicReady standard user import format (first name,last name,email,user id,telephone number,group id,database id) you can export the user data from your database in XML format and post it to a secure URL directly or by posting a text(txt) file.

Once the data is received the users will be processed immediately. All of our standard .csv processing rules apply to the API as well.

In addition, the membership API allows you to retrieve data from CivicReady in order to synchronize back to your database providing you with a two-way membership import that will improve data accuracy between the two systems.

With the Membership API You Will Be Able to:

  • Retrieve data: user changes within a given time period, admin permissions, and more
  • Instantly process and manage your users
  • Create and manage groups via API (create, purge, delete)
  • Approve pending requests (pending topic and membership requests)
Membership API Instructions XML Format
   
API URL  https://regroup.com/api/v2/users?api_key=NetworkAPIKEY

(You have to post the xml data to this URL, Content-Type must be 'application/xml’ and the submit method must be POST to make this work.)
  Root tag must be named "users" and type must be array. If the users tag and type is missing, the API will not process the request.
  <?xml version="1.0" encoding="UTF-8"?>
<users type="array">
<user>
<firstName>user1</firstName>
<lastName>Test1</lastName>
<email>user1Test1@email.edu</email>
<userID>user1Test1</userID>
<phone>5555551212</phone>
<groupID>XXXXXX</groupID>
<databaseID>User1Test1DBID1</databaseID>
<address>123 Main St., New York, NY, 10036</address>
<customFields>Data 1|Data 2|Data 3</customFields>
<campusName>Campus 1</campusName>
</user>
<user>
<firstName>User2</firstName>
<lastName>Test2</lastName>
<email>User2Test2@email.edu</email>
<userID>Test2</userID>
<phone>5555551213</phone>
<groupID>XXXXXX|0|1|1</groupID>
<databaseID>User2TestDBID2</databaseID>
<digestEmails>1</digestEmails>
</user>
</users>
   
There must be at least one user tag under users tag and there is no maximum limit on the number of user tags you can import.
The data will be processed according to current .csv processing rules Network/Group setting.
The user tag has these child tags

<firstName>User1</firstName> (Required)
<lastName>Test1</lastName> (Optional)
<email>User1Test1@email.edu</email> (Required)
<userID>user1Test1</userID> (Required for SSO)
<phone>5555551212</phone> (Optional)
<groupID>XXXXXX</groupID> (Required, Group ID functions are Optional)
<databaseID>User1Test1DBID1</databaseID> (Optional)
<address>123 Main St., New York, NY, 10036</address>(Optional)
<customFields>Data 1|Data 2|Data 3</customFields>(Optional)
<digestEmails>1</digesEmails> (Optional)
   
   
Example curl command to submit request to API:  
   
1. Post using xml data directly in the command curl -H 'Content-Type: application/xml' -X POST -d '<?xml version="1.0" encoding="UTF-8"?>
<users type="array">
<user>
<firstName>user1</firstName>
<lastName>Test1</lastName>
<email>user1Test1@email.edu</email>
<userID>user1Test1</userID>
<phone>5555551212</phone>
<groupID>XXXXXX</groupID>
<databaseID>User1Test1DBID1</databaseID>
<address>123 Main St., New York, NY, 10036</address>
<customFields>Data 1|Data 2|Data 3</customFields>
<campusName>Campus 1</campusName>
</user>
<user>
<firstName>User2</firstName>
<lastName>Test2</lastName>
<email>User2Test2@email.edu</email>
<userID>Test2</userID>
<phone>5555551213</phone>
<groupID>XXXXXX|0|1|1</groupID>
<databaseID>User2TestDBID2</databaseID>
<digestEmails>1</digestEmails>
</user>
</users>' https://regroup.com/api/v2/users?api_key=NetworkAPIKEY
   
2. Post using a file e.g. users.xml: curl -H 'Content-Type: application/xml' -X POST -d @users.xml https://regroup.com/api/v2/users?api_key=NetworkAPIKEY

 

For more information on how you can add this new feature to your network please contact CivicReady Support. 

?



I'd Like to Request an Enhancement

0 out of 0 found this helpful

Updated:
Follow