Introduction
API endpoints have been added to eKeeper to allow the use of integration apps such as Zapier to allow eKeeper to work with other applications.
...
POST
...
Authorisation
The API is protected by OAuth2 authorisation. The implementation of this is covered here: Link to Page
This means that all API requests must include the Authorization header which contains the text 'Bearer' with a trailing space followed by the access token.
API Endpoints
...
Create Mortgage
...
| borderColor | #aaaaaa |
|---|---|
| bgColor | #dddddd |
| borderWidth | 1 |
| borderStyle | solid |
...
Create a Case, Customer and Mortgage Product in eKeeper.
Headers
...
...
Body
urlencoded
| customerForename | Joan | |
| customerSurname | Smith | |
| customerDateOfBirth | 1948-08-15T00:00:00 | |
| customerPostCode | AB12 3DC | |
| customerAddress | 1 Lower Street | |
| customerEmail | address@email.com | |
| customerPhone | 01234567890 | |
| loanAmount | 150000 | |
| term | 12 | |
| productSubType | 36 | |
| stage | 25 | |
| user | 3 | |
| notes | Some case notes about the mortgage... | optional |
| action | 12 |
POST Create Insurance
...
...
/new/api/external/insurance
Create a Case, Customer and Insurance Product in eKeeper.
Headers
| Accept | application/json |
| Content-Type | application/x-www-form-urlencoded |
| Authorization | Bearer <OAuth2 Access Token> |
Body
...
| customerForename | Joan | |
| customerSurname | Smith | |
| customerDateOfBirth | 1948-08-15T00:00:00 | |
| customerPostCode | AB12 3DC | |
| customerAddress | 1 Lower Street | |
| customerEmail | address@email.com | |
| customerPhone | 01234567890 | |
| sumAssured | 150000 | |
| term | 12 | |
| productSubType | 29 | |
| status | 3 | |
| user | 3 | |
| notes | Some case notes about the mortgage... | optional |
| action | 14 |
GET Get Users
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/users |
Get a list of users from eKeeper
Headers
...
GET Get Users - Me
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/users/me |
Check user is authorised. Used for testing OAuth access.
Headers
...
GET Get Stages
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/stages |
Get a list of stages from eKeeper
Headers
...
GET Get Statuses
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/insurance/statuses |
Get a list of statuses from eKeeper
Headers
...
GET Get App Stage History
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/insurance/statuses |
Returns the latest 50 App Stage History rows for triggering events based on stage changes.
Headers
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/product/actions |
Get a list of actions from eKeeper
Headers
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/productsubtype?productGroupPK=2 |
Get a list of product sub types from eKeeper
Headers
...
Params
...
Introduction
API endpoints have been added to eKeeper to allow the use of integration apps such as Zapier to allow eKeeper to work with other applications.
These integrations work by consuming information about data changes within the application via GET requests and causing data changes within the application via POST requests. There are also a number of supporting endpoints where the user may need to select a value from the database as part of setting up the integration. For example choose a Stage name or a User.
Authorisation
The API is protected by OAuth2 authorisation. The implementation of this is covered here: Link to Page
This means that all API requests must include the Authorization header which contains the text 'Bearer' with a trailing space followed by the access token.
API Endpoints
POST Create Mortgage
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/mortgage |
Create a Case, Customer and Mortgage Product in eKeeper.
Headers
...
application/x-www-form-urlencoded
...
Body
urlencoded
...
POST Create Insurance
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/insurance |
Create a Case, Customer and Insurance Product in eKeeper.
Headers
...
application/x-www-form-urlencoded
...
Body
urlencoded
...
GET Get Users
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/users |
Get a list of users from eKeeper
Headers
...
GET Get Users - Me
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/users/me |
Check user is authorised. Used for testing OAuth access.
Headers
...
GET Get Stages
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/stages |
Get a list of stages from eKeeper
Headers
...
GET Get Statuses
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/insurance/statuses |
Get a list of statuses from eKeeper
Headers
...
GET Get App Stage History
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/insurance/statuses |
Returns the latest 50 App Stage History rows for triggering events based on stage changes.
Headers
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/product/actions |
Get a list of actions from eKeeper
Headers
...
| Panel | ||||||||
|---|---|---|---|---|---|---|---|---|
| ||||||||
/new/api/external/productsubtype?productGroupPK=2 |
Get a list of product sub types from eKeeper
Headers
...
Params
| Accept | application/json | |
| productGroupPK | 2