Loading...
 

Xeerpa Enterprise API

This document contains technical specifications regarding Xeerpa Enterprise API, including available web services and data descriptions

This is the standard documentation, if you need and ad hoc connection with your CRM contact with us.

Xeerpa Enterprise API is a REST API. Calls to Xeerpa Enterprise API web services return a JSON object with the requested information and/or a description of the result (error or success).

The URL to be used varies depending on each client. Please get in touch with our technical team to find out which one you should use, as well as the user id and password that you will need when calling the services, as detailed in this document. The request url will have a format similar to this:

https://api-subdomain.xeerpa.com

 

The following parameters are common to all requests:

clientId
Your unique client id. Please get in touch with our technical team to find out which one you should use.
clientPwd
Your unique client password. Please get in touch with our technical team to find out which one you should use.
userId
It may be the user’s Xeerpa id, the user’s CRM id or the user’s email

 

Typically, these and all required parameters will be sent in a GET request, as part of the request’s body.

 

Example:

Call:

https://api-subdomain.xeerpa.com/api/user/details?clientId=4f9k30dws0&clientPwd=99dg9djs4g9d9s&userId=596373234

 

Result:

{
‘id’ : ‘596373234,
‘name’ : ‘John’,
‘surname’ : ‘Smith’
}

 

Depending your Enterprise version you´ll have some web services or others: