eGifter API

The purpose of this document is to outline the integration calls between eGifter Platform Services and eGifter Service partners. eGifter partners will use this document as a reference of the various integrations calls necessary to implement the eGifter Platform.

Getting started

eGifter uses the REST API to allow partners to interact with the eGifter servers. eGifter’s REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. The eGifter API is a RESTful API and conforms to the REST design principals. The API organization is separated by the types of access points available. API methods will be standard HTTP methods including; GET, POST, PUT and DELETE. Because the REST API is based on open standards, you can use any web development language to access the API.

How to

Request data is passed to the API by POSTing JSON objects to the API endpoints with the appropriate parameters. The documentation for each API call will contain more detail on the parameters accepted by the call.

We support the following two output formats:

  • JSON (default)
  • XML

By default we return JSON. To retrieve as XML, simply set a HTTP header content-type to text/xml. The response data for each call will be encoded in the specified format. Regardless of the output format desired, inputs are only accepted as JSON objects or HTTP POST parameters.

Security Authentication

SECURITY

//authentication

client validation

customer authorized IP address (provided by customer)

authorization token

unique token generated per partner

method

custom HTTP header used to pass authorization token

token expiration

token are regenerated every six months and provided to partner