Alumni Application API & SDK Framework

, Alumni Application API & SDK Framework

For full documentation relating to the EnterpriseAlumni API including versioning, migration and access levels please access the EA Support Portal.

All integrations and access to the EnterpriseAlumni application require user permissions being assigned against the endpoints requested and all requests require review by the EA Integrations Team.

There is no public API / user API. The below provides a general overview of the EnterpriseAlumni API and common questions.


Coming Soon: SDK / DevKit

We are currently developing an SDK to enable our customers to access their data programmatically and enable our partner community to build applications around our platform.

v0.1 is scheduled for beta release Q3 2019


Overview

EnterpriseAlumni is built on top of a RESTful JSON API. This API is used for all data access inside of the application. The API is the part of the application layer of the application.

The API is built on the principles of REST. The URLs are resource-oriented, so that they are easily guessable, and follow a pattern. The API makes use of many HTTP features such as the verbs and response codes, and HTTP authorization is used for private access. Many other design decisions were based on the JSONAPIspec, although our API does not follow the JSONAPI spec 100% at present.


Stability & Progress

We are actively working in a new version of our API and authentication methods, to making access to data, integrations, and automations as simple as possible.


Access Levels

The Alumni application maintains a private API which provides access to data and automations in accordance with the permissions of the user making the request.


Error Handling

The application uses HTTP response code to indicate the success or failure of a request.

The codes consist of 3 numbers. The first number generally denotes the type of error.

2xx codes generally indicate success, 4xx codes indicate a problem with the request that was sent, such as failed authentication or incorrect query parameter/syntax etc, and 5xx codes means that something went wrong on our side.

In the event of a 5xx code a ticket is automatically generated on your behalf and escalated to the support team, you will receive an email notification with the EA Ticket number.


Pagination

When fetching multiple resources from an endpoint, e.g. performing a ‘browse’ request the number of items returned will be limited to 25 by default.

The API currently uses page-based pagination, which is controlled via the two parameters Limit and Page. The API returns page 1 by default, and requesting page 2 will send the next 25 items. Alternatively you can make a request for more or less items, so that you can get the exact data that you need, by changing the limit.

When browsing certain endpoints you will retrieve an array of your queried resource and a meta object that includes a pagination object.


Authentication

Currently in order to make HTTP requests to write to this API or to read private data, you must first obtain your current Bearer Token by exchanging user credentials. In the future this should be possible using Client Authentication.

Please visit the EA Support Portal for more information


How To Make A Request Via Postman!

Step-by-step instructions!