CRM API

Data Transfer

FocusPoint CRM API is a JSON based Web API which transfers the data in JSON format. In order to consume the API, the client should send input as a valid JSON data and the API will return the data in JSON format.

Please include Content-Type header as in below format for every request.
Content-Type: application/json

Authentication

FocusPoint CRM API uses HTTP basic authentication to authenticate all the incoming requests.

Basic authentication works as follows:

• The client should invoke the API with the client credentials in the Authorization header.
• If the request is authenticated, the client will be served with the required API Call. If the credentials are invalid or when there is no authorization header present in the API call, the api will reject the request by sending HTTP Status Code 401.

The client should include the authorization header in the below format in order to authenticate the request.

Authorization: Basic RlBUZXN0OkZQUGFzc3dvcmQ=
 RlBUZXN0OkZQUGFzc3dvcmQ= - Base64 encoded value of UserName:Password
Test Credentials:
UserName : FPTest
 Password : FPPassword

HTTP Response

Below is the list of HTTP Status Code and Message that API will return

HTTP Status Code	Response	Description
200	Valid JSON data / Empty data	For all successful request, API will either return the data in JSON format when something needs to be communicated to the client or the api will not return any data.
401		API will return 401 when the authentication failed due to the incorrect credentials or due to the incorrect authorization header.
500	{ "Message": "Member Not Found. Please provide valid Membership Code for update.", "AppErrorcode": "2001" }	API will return this status when there is something wrong with the request or the input data. The returned data will have ErrorCode and detailed description of the error.