CRM App API Documentation - CRM Software | Sales CRM Software class="post-template-default single single-post postid-83 single-format-standard wp-custom-logo"

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. Digital CRM APIs belongs to the REST (Representational State Transfer) category. The REST methods include: GET, POST, PUT and DELETE request.

Request Methods

 

Definition

 

GET

 

Fetching the data

 

POST

 

Store the data

 

PUT

 

Update the data

 

DELETE

 

Destroy the data

 

Http client:

Http client refers to a request you send and get the response from the server in http format. For this application we have tested the API in postman to get the response.

“Postman is a platform for API development which is used to build, test and modify the APIs”.

Using Postman:

  • We recommend to testing these APIs first download and install the postman. Link: https://www.postman.com/.
  • Method: GET/POST/PUT/DELETE
  • Body: Used this section when you want to POST/PUT the request.
  • Add parameter in Headers section like:
    • Key: Accept Value: application/json
    • Key: Authorization Value: Bearer your_auth_token
  • URL: https://digitalcrm.com/crm/api/your_routes

Authentication:
In this APIs support OAuth2.0 authentication. For accessing the APIs you need to authenticates or access token first.
How to get token? If you are using the postman then first register in our application and then put your log in credentials in postman. You’ll get the oAuth2.0 token.

User API: In this we have provided the user register, login, logout and forgot password and reset password API:

1. Register Api: Open postman and set the fields:
Method: POST
Params: name, email, password, c_password
URL: https://digitalcrm.com/crm/api/register

2. Login Api: set the fields same as register like:
Method: POST
Params: email, password
Url: https://digitalcrm.com/crm/api/login
After logged in you will get the token like this:

Copy your token except semicolon and paste it the Header section of postman where Key: Authorization and Value: Bearer your_token_paste.

Like this:

3. Get all users list: In this you’ll fetch all user details, so set the fields in postman.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/all/users

4. User Profile: To get the information of your current logged_user or your profile.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/profile

Currency: Fetching all currency lists.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/currency

Industry Types: Fetch all industry lists.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/industrytypes

Account: companies with whom you have an existing business relationship are saved in accounts in DigitalCRM.

1. Account Types: You’ll fetch the list of account types in DigitalCRM.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/accounttypes

2. Account List all: Using this to fetch the all account list.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account/lists

3. Account Detail: To get the information of current logged in user account details.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account/details

4. Account list: To get the list of accounts created by the current user.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account

5. Account Create: Create an account.
Method: POST
Params: name, mobile, email, phone, actype_id, intype_id, description, website, country, state, city, street, zip, company, employees, picture.
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account

6. Account Update: Using this API you can update an account by placing the account id in the end of URL.
Method: PUT
Params: name, mobile, email, phone, actype_id, intype_id, description, website, country, state, city, street, zip, company, employees, picture.
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account/enter_account_id

7. Account Delete: Using this API you can delete an account by placing the account id in the end of URL.
Method: DELETE
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/account/enter_account_id


Lead: A lead refers to a raw data or you can say that detailed collected information of an individual, organization or gathered information of a person.

1. Lead Status: You can fetch the lead types from DigitalCRM.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/leadtypes

2. Lead List all: Using this to fetch the all lead list.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/lead/lists

3. Lead Details: To get the information of current logged in user lead details list.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/lead/details

4. Lead list: To get the list of lead list created by the current user.
Method: GET
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/leads

5. Lead Create: Create a lead.
Method: POST
Body: first_name, last_name, picture, email, picture, phone, mobile, website, notes, pro_id, acc_id, ldsrc_id, ldstatus_id, intype_id, street, state, country, zip, company, designation.
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/leads

6. Lead Update: Using this API you can update a lead by placing the lead id in the end of URL.
Method: PUT
Body: first_name, last_name, picture, email, picture, phone, mobile, website, notes, pro_id, acc_id, ldsrc_id, ldstatus_id, intype_id, street, state, country, zip, company, designation.
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/leads/enter_leads_id

7. Lead Delete: Using this API you can delete a lead by placing the lead id in the end of URL.
Method: DELETE
Header:
o Key: Accept and Value: application/json
o Key: Authorization and Value: Bearer your_token
URL: https://digitalcrm.com/crm/api/leads/enter_account_id

Tags: