API Documentation - Webflow

API Documentation

Rev 1/5/17

Contents:

Integration Considerations

1

Data Mapping

1

Middleware

2

Synchronization

2

Step 1: Determine the Business Requirements of your Integration

3

Step 2: Decide What Data to Synchronize

3

Step 3: Create the Synchronization Script

3

Getting Started with the API

5

360Alumni provides the following REST endpoints and methods:

5

The API URLs

5

Get Your API Key

5

Requesting Data

5

Filtering Responses

12

Filtering Campaign Results

12

Filtering Donation Results

15

Filtering User Results

18

Creating and Updating Users

21

Create a New User with POST /api/users/

21

Get an Array of User Records with GET /api/users/

22

Get a Specific User's Record with GET /api/users/{id}

23

Update a User Record with PUT /api/users/{id}

27

API Documentation, Page 1 of 28

Integration Considerations

Data Mapping

You'll need to create a plan for how to keep your data models synchronized. Data must

be pulled from 360Alumni's API rather than pushed via an event-driven integration

model. So your integration needs to periodically scan the data and provide a change log

to act upon.

Once you have decided upon your synchronization model, you need to identify which

fields you are going to keep synchronized between the two systems. Use the User

Object reference page to help with your mapping. You can also download a copy of the

following spreadsheet to use for your mapping:

1. Open the 360Alumni ?User Data Mapping Template?.

2. Select F

? ile > Download as >?, from the open template.

3. Select your preferred format to save the spreadsheet:

¡ð

¡ð

¡ð

¡ð

Excel

OpenDocument

Comma separated values (CSV)

Tab separated values (TSV)

4. The template is sorted by ?JSON? field column. You might find it useful to do your

mapping by resorting your spreadsheet by the ?Preferred Order? column.

Middleware

Another consideration is the middleware that provides the "bridge" between 360Alumni

and your database. Middleware provides enforcement of business logic such as

conversion of the data format or structures. Another example of middleware tasks is

adding a layer of protection so bad data or glitches can not create chaos in the

destination system. An example of middleware is Zapier, which is a middleware

"clearinghouse" - offering prepackaged middleware "scripts" for thousands of software

applications. 360Alumni has a privately available "Zap" which can be used by our clients

who run Salesforce.

API Documentation, Page 2 of 28

Synchronization

One method of integrating your application with 360Alumni is via a polling and

synchronization method. This involves checking the database periodically for changes

and then updating records accordingly. A polling and sync integration works by running

a script that checks for updates and then will update a target based on changes. You

can make these integrations two-way by simply applying the business logic you create

to both checks.

The following integration example uses a CRM to show how a sync integration can

work. Awesome University has a CRM that they use to keep track of their alumni and

ensure they can keep track of their donations. They have recently become a partner

with 360Alumni and would like to ensure that their alumni database in their CRM and

360Alumni remains in sync. In order to accomplish this they will be setting up a sync

with 360Alumni using the "Users" endpoint of the API.

¡ñ Step 1: Determine the Business Requirements of your Integration

¡ñ Step 2: Decide What Data to Synchronize

¡ñ Step 3: Create the Synchronization Script

Step 1: Determine the Business Requirements of your Integration

For Awesome University's integration they have determined they want to perform a two

way sync with 360Alumni and the contacts in their CRM system. They determined this

by finding out the business requirements by talking with stakeholders in their

organization. This involved a short series of meetings where they discussed what data

they wanted to keep in sync with 360Alumni. They decided upon a two way sync

because it would allow them to maintain their alumni directory both organically and still

be able to manage it through their CRM.

Step 2: Decide What Data to Synchronize

API Documentation, Page 3 of 28

Awesome University had to decide what parts of their contact data they wanted to keep

in sync, so they referred to 360Alumni's field list and settled upon the first name, last

name, email, and phone number fields only. They did this because they had only

maintained these pieces of contact information in their CRM so they wanted to get them

updated as users provided updates. They could have included additional fields but

chose a lean approach for phase 1 of their integration.

Step 3: Create the Synchronization Script

Awesome University maintains a couple of in house servers so they decided their script

will be written in node.js and run once a day at 1 AM on one of their linux environments.

Their script will simply look at records that were changed in each system and then

update or create records on each of the respective environments. This also allows

Awesome University to put in any transformations they need.

API Documentation, Page 4 of 28

Getting Started with the API

360Alumni provides the following REST endpoints and methods:

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

¡ñ

/api/campaigns/

GET method

/api/campaigns/{id}

GET method

/api/donations/

GET method

/api/users/

GET and POST methods

/api/users/{id}

GET and PUT methods

The API URLs

Use one of the following URLs to open the API reference.

Test system



Your system



Get Your API Key

Before you can use the API you'll need to get your API key, which you use to

authenticate with the API. Your account manager at 360Alumni will coordinate with

our Client Integrations Team to create an API key for your organization. Once you

have the key, connecting to the 360Alumni API is easy. For each API request,

simply include your API key as the value in an HTTP header named ?x-api-key.? See

the examples for details.

API Documentation, Page 5 of 28

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download