CRM App API Documentation

 
The REST API provides an easy-to-use set of HTTP endpoints that let you access your site’s data in simple JSON format, including users, leads, taxonomies and more. Retrieving or updating data is as simple as sending a HTTP request.

The web services help you build applications and manage your CRM Account and the associated CRM data using CRM REST API.

HEAD, GET, POST, PUT, and DELETE Requests

These HTTP methods represent the action of a HTTP client might perform against a resource. For instance, GET requests are used to fetch a data, where as DELETE requests are used to delete.

HTTP Client

The phrase HTTP Client refers to the tool you use to interact with API. You might use Postman(Chrome) or REST Easy (Firefox) to test requests in your browser, or http to test requests at the commandline.

Framework: Slim – https://www.slimframework.com/

API’s List:


register

To register in to application

login

To login into application

logout

To logout from application

forgetPassword

When user forgot the password

updateUserdetails

To update user details

getUserdetails

To get user details

getCurrency

To get list of currency

getAccounttypes

To get list of account types

getLeadsourcetypes

To get list of lead source types

getLeadsstatustypes

To get list of lead status types

getIndustrytypes

To get list of industry types

getSalesfunnel

To get list of sales stage

getAccountdetails

To get account details

addAccount

To add an account

editAccount

To edit an account

getAccountlist

To get list of accounts

deleteAccount

To delete account

getAppmenu

To get app menu list

getAppsidemenu

To get side menu list

getCountrylist

To get list of countries

getStatelist

To get list of state list

addLead

To add lead

getLeadlist

To get list of leads

getLeaddetails

To get lead details

editLead

To edit lead details

deleteLead

To delete lead

API Usage:


/register:
Method: POST
Headers:
content-type: x-www-form-urlencoded
Parameters:
name
email
password
device_token
platform
Platform:
1 – Android
2 – IOS
Sample:name=sandeep&email=isandeep@gmail.com&password=123456& =1234&platform=1
/login:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
Parameters:
email
password
device_token
platform
Platform:
1 – Android
2 – IOS
Sample:email=isandeep@gmail.com&password=123456&device_token=1234&platform=1
/logout:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/forgetPassword:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
Parameters:
email
/updateUserdetails:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
name
email
password
mobile
job_title
fileUpload
currency
Sample:name=sandeep&email=isandeep@gmail.com&password=123456&currency=3&mobile=8978865401&job_title=executive
/getUserdetails:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getCurrency:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getAccounttypes:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getLeadsourcetypes:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getLeadsstatustypes:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getIndustrytypes:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getSalesfunnel:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getAccountdetails:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/addAccount:
Method: POST
Headers:
content-type: multipart/form-data
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
name
email
phone
mobile
employees
Description
Industry_type
account_type
description
fileUpload
country
state
city
zip
street
Sample: name=accountone&email=account.one@gmail.com&mobile=8756491230&
phone=8523697414&employees=2&industry_type=2&account_type=3&
description=this is account one description&country=&state=&city=&zip=&street=
/editAccount:
Method: POST
Headers:
content-type: multipart/form-data
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
acc_id
name
email
phone
mobile
employees
Description
Industry_type
account_type
description
fileUpload
country
state
city
zip
street
Sample: name=accountone&email=account.one@gmail.com&mobile=8756491230&
phone=8523697414&employees=2&industry_type=2&account_type=3&
description=this is account one description&country=&state=&city=&zip=&street=
/getAccountlist:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
limit
Sample:
limit=0 – first time
limit=31 – second time
/deleteAccount:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
acc_id
uid
/getAppmenu:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getAppsidemenu:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getCountrylist:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
uid
/getStatelist:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: 923c0469b9c23c3dff1b45cd29522293
Parameters:
id
uid
/addLead:
Method: POST
Headers:
content-type: multipart/form-data
authorization: d4c759a0b9cd5c2ee8b52cbae48ec741
Parameters:
uid
fname
lname
email
phone
mobile
account
Industry_type
leadsource_type
leadstatus_type
notes
website
fileUpload
country
state
city
zip
street
Sample:fname=one&email=leadone@gmail.com&mobile=8541236970&lname=lead&industry_type=1&leadsource_type=1&leadstatus_type=1&website=google.com&phone=&
notes=testing lead&account=1&country=&state=&city=&street=&zip=&
/getLeadlist:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: d4c759a0b9cd5c2ee8b52cbae48ec741
Parameters:
limit
uid
Sample:
limit=0 – first time
limit=31 – second time
/getLeaddetails:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: d4c759a0b9cd5c2ee8b52cbae48ec741
Parameters:
uid
ld_id
/editLead:
Method: POST
Headers:
content-type: multiplart/form-data
authorization: d4c759a0b9cd5c2ee8b52cbae48ec741
Parameters:
uid
fname=three testing
email=leadthree@gmail.com
mobile=8541236971
lname=lead
industry_type=1
leadsource_type=1
leadstatus_type=1
website=rediff.com
phone=7854123691
notes=testing lead
account=1
country=India
state=Delhi
city=Delhi
street=
zip=
ld_id=108
/deleteLead:
Method: POST
Headers:
content-type: application/x-www-form-urlencoded
authorization: d4c759a0b9cd5c2ee8b52cbae48ec741
Parameters:
uid
ld_id
Posted in CRM