Request Type | GET |
---|---|
Request URL | baseURL + admin/access-token |
Required Fields : | |
organisation's email | |
password | organisation's password |
organisation_domain | organisation's sub domain name |
addon_unique_name | unique name of addon |
This api does not require access_token in header
Expected Output :{ "status": 1, "data": { "access_token": access_token using for external api, "refresh_token": refresh_token using for regenerate token, "expire_in": how long the access_token is valid (In sec), "organisation_domain": sub domain name of organisation } }
Request Type | POST |
---|---|
Request URL | baseURL + admin/access-token/validate |
Required Fields : | |
access_token | access token of a addon |
refresh_token | refresh token of a addon |
addon_unique_name | unique name of addon |
This api does not require access_token in header
Expected Output :{ "status": 1, "data": { "access_token": access_token using for external api, "refresh_token": refresh_token using for regenerate token, "expire_in": how long the access_token is valid (In sec), "organisation_domain": Sub domain name of organisation } }
Request Type | POST |
---|---|
Request URL | baseURL + admin/access-token/regenerate |
Required Fields : | |
access_token | access token of a addon |
refresh_token | refresh token of a addon |
This api does not require access_token in header
Expected Output :{ "status": 1, "data": { "access_token": new access_token when token is expired, "refresh_token": new refresh_token when token is expired, "expire_in": how long the access_token is valid (In sec), "organisation_domain": sub domain name of organisation } }
Request Type | POST |
---|---|
Request URL | baseUrl + admin/check-widget-visiblity |
Required Fields : | |
domain_name | domain name of addon |
{ "type": "success" or "failure" "data": { "isWidgetVisible": widget visiblity status (true or false) "reason": reason of invisiblity of widget (when visiblity status false) } }
Request Type | POST |
---|---|
Request URL | baseUrl + admin/operator/create |
Required Fields : | |
email of operator or user | |
Optional fields : | |
first_name | first name of operator // This field is used when you register a new mail Id for operator or user |
last_name | last name of operator |
{ "status": 1, "data": { "id": id of operator // Used to get and update operator details "name": name of operator "email": email of operator "addon_unique_name": addon unique name at which operator create } }
Request Type | GET |
---|---|
Request URL | baseUrl + admin/operator/operatorId |
{ "status": 1, "data": { "_id": id of operator "name": name of operator "email": email of operator "status": status of operator // 0 => offline 1=> online 3=> busy 2=> away "operator": true => operator, false => not a operator } }
Request Type | PUT |
---|---|
Request URL | baseUrl + admin/operator/update/operatorId |
Required Fields : | |
Updated Fields (This field is mandatory for update) : | |
status | accepted value 0 or 1 // (operator 1=> active or 0=> inactive only for the perticuler addon) |
{ "status": 1, "data": 'Status Changes Successfully' }
Request Type | POST |
---|---|
Request URL | baseUrl + admin/domain/create |
Required Fields : | |
domain_name | name of domain // without http:// or https:// |
email for domain register |
{ "status": 1, "data": { "name": name domain "email": email of domain "status": status of domain // true => active or false => inactive "addon_unique_name": addon unique name at which domain create "link": use this code at merchant website //this link is only provided for seller_buyer_chat_System } }
Request Type | GET |
---|---|
Request URL | baseUrl + admin/domain/domain_name |
{ "status": 1, "data": { "name": name of domain "email": email of domain "status": status of domain // true => active false=> inactive } }
Request Type | PUT |
---|---|
Request URL | baseUrl + admin/domain/update/domain_name |
Required Fields : | |
updated Fields (minimum one field is mandatory for update) : | |
name | name of domain // which you want to update |
status | status of domain // true => active, false => inactive |
email for domain // which you want to update |
{ "status": 1, "data": { "name": domain_name // updated value "status": status of domain // updated value "email": email of domain // updated value } }
Request Type | POST |
---|---|
Request URL | baseUrl + admin/operator/assign |
Required Fields : | |
domain_name | name of domain // name of domain at which create operator |
operator_id | id of operator // operator's id that you want to assign at domain |
Optional Fields : | |
unique_id | unique_id of seller product page // This field is used only for seller_buyer addon |
is_admin | make operator as a admin // true => active, false => inactive |
{ "status": 1, "data": { "operators": { "name": name of operator "email": email of operator "userId": id of operator "unique_id": unique_id of seller buyer product page // only for seller buyer addon "is_admin": make operator as a admin or not // true => active, false => inactive } } }
Request Type | PUT |
---|---|
Request URL | baseUrl + admin/operator/assign/operatorId |
Required Fields : | |
domain_name | name of domain |
Updated Fields (minimum one field is mandatory for update) : | |
unique_id | unique_id for which you want to update // This is used only for seller buyer |
is_admin | true or false // which you want to update |
online_status | true or false // operator visible online or offline |
status | true or false // operator getting message or not and this field is only for seller buyer |
{ "status": 1, "data": { "addon_unique_name": unique name of addon "domain_name": domain name of addon "operators": { "online_status": visibility of operator online or offline "unique_id": unique_id of seller buyer product page // only for seller buyer addon "is_admin": make operator as a admin or not // true => active, false => inactive "status": true => operator getting message, false => operator didn't getting the message } } }