Info
Welcome to the generated API reference. Get Postman Collection
0.1 Admin Login management
Route for Login Admin & Moderator
Admin Login Page
Requires authentication
Admin Data Page That Login Admin To the Website and give him access if the validation was right To the Website.
Example request:
curl -X GET \
-G "/admin-login" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","password":"*****"}'
const url = new URL(
"/admin-login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"password": "*****"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET admin-login
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | The email of the Admin. |
password |
string | required | The password of the Admin. |
Admin Login Request
Requires authentication
Admin Data Request That Login Admin To the Website and give him access if the validation was right To the Website.
Example request:
curl -X POST \
"/admin.login" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","password":"*****"}'
const url = new URL(
"/admin.login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"password": "*****"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST admin.login
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | The email of the Admin. |
password |
string | required | The password of the Admin. |
0.2 Login management
Route for Login Users
Show the application's login form.
Example request:
curl -X GET \
-G "/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET login
Handle a login request to the application.
Example request:
curl -X POST \
"/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST login
Log the user out of the application.
Example request:
curl -X POST \
"/logout" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/logout"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST logout
User Login Page
Requires authentication
User Data Page That Login User To the Website and give him access if the validation was right To the Website.
Example request:
curl -X GET \
-G "/first" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","password":"*****"}'
const url = new URL(
"/first"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"password": "*****"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET first
POST first
PUT first
PATCH first
DELETE first
OPTIONS first
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | The email of the User. |
password |
string | required | The password of the User. |
0.3 Register management
Route for Register Users
Show the application registration form.
Example request:
curl -X GET \
-G "/register" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET register
User Register Page
Requires authentication
User Data Request That Register User To the Website and give him access if the validation was right To the Website.
Example request:
curl -X POST \
"/register" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","email":"test@demo.com","phone":"123456","country_code":"+20","password":"******"}'
const url = new URL(
"/register"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"email"<EMAIL_ADDRESS>"phone": "123456",
"country_code": "+20",
"password": "******"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST register
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
string | required | The phone of the user. |
country_code |
string | required | The country_code of the user. |
password |
string | required | The password of the user. |
User Register Page
Requires authentication
User Data Request That Register User To the Website and give him access if the validation was right To the Website.
Example request:
curl -X GET \
-G "/login2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","email":"test@demo.com","phone":"123456","country_code":"+20","password":"******"}'
const url = new URL(
"/login2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"email"<EMAIL_ADDRESS>"phone": "123456",
"country_code": "+20",
"password": "******"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET login2
POST login2
PUT login2
PATCH login2
DELETE login2
OPTIONS login2
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
string | required | The phone of the user. |
country_code |
string | required | The country_code of the user. |
password |
string | required | The password of the user. |
1.1 Admin management
Page Group To manage Admin data & Lists Stats Of The Site In General .
Dashboard
Requires authentication
Is A Dashboard Page That Shows Lists Of Stats & General Data Of The Site In General That admin can view stats and make decisions from the stats brief in front of him to manage the site more efficient .
- Statistics For All The Site .
- Diagrams For Data Of Workplaces.
- Diagrams For Data Of Products.
- Diagrams For Data Of Users.
- Diagrams For Data Of Leads.
- Counter For Workplaces All Over the Site .
- Counter For Products All Over the Site .
- Counter For Users All Over the Site .
- Counter For Leads All Over the Site .
Example request:
curl -X GET \
-G "/admin/dashboard" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/dashboard"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"workplaces_count": 19,
"products_count": 28,
"users_count": 32,
"leads_count": 86
}
HTTP Request
GET admin/dashboard
1.2 Admin Moderator management
Page Group To manage Moderator data For The Admin Control Panel .
- View the moderator Data Ex. Name, Email & Phone .
- Create New Moderators for the Site .
- Edit an existing Moderators from the Edit Button .
- Delete Moderators From the delete Button .
Moderators View Page
Requires authentication
Is An Admin-Panel Moderator Page That Views Moderators Data Info .
Example request:
curl -X GET \
-G "/admin/moderator" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/moderator"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Demo Mato",
"phone": 123456789,
"email"<EMAIL_ADDRESS>"created_at": "2020-12-29 14:13:08",
"updated_at": "2020-12-29 14:13:08",
"role": 1
}
HTTP Request
GET admin/moderator
Moderator Create Page
Requires authentication
Is An Admin-Panel Moderator Page That Creates Moderators To Manage The Web Site Generally .
Example request:
curl -X GET \
-G "/admin/moderator/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","email":"test@demo.com","phone":123456789,"zones":"Alex"}'
const url = new URL(
"/admin/moderator/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"email"<EMAIL_ADDRESS>"phone": 123456789,
"zones": "Alex"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Demo Mato",
"phone": 123456789,
"email"<EMAIL_ADDRESS>"created_at": "2020-12-29 14:13:08",
"updated_at": "2020-12-29 14:13:08",
"role": 1
}
HTTP Request
GET admin/moderator/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
integer | required | The phone of the user. |
zones |
string | optional | The Zone selected of the user. |
Moderator Store Data
Requires authentication
Is An Admin-Panel Moderator Data Request That Stores Moderators Data To Database .
Example request:
curl -X POST \
"/admin/moderator" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/moderator"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
POST admin/moderator
Moderator Edit Page
Requires authentication
Is An Admin-Panel Moderator Page That Edits Moderators To Manage The Web Site Generally .
Example request:
curl -X GET \
-G "/admin/moderator/1/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo<EMAIL_ADDRESS>.","phone":123456789,"zones":"Alex ."}'
const url = new URL(
"/admin/moderator/1/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo .",
"email"<EMAIL_ADDRESS>.",
"phone": 123456789,
"zones": "Alex ."
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Demo Mato",
"phone": 123456789,
"email"<EMAIL_ADDRESS>"created_at": "2020-12-29 14:13:08",
"updated_at": "2020-12-29 14:13:08",
"role": 1
}
HTTP Request
GET admin/moderator/{moderator}/edit
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
integer | required | The phone of the user. |
zones |
string | optional | The Zone selected of the user. |
Moderator Update Data
Requires authentication
Is An Admin-Panel Moderator Data Request That Updates Moderators Data To Database .
Example request:
curl -X PUT \
"/admin/moderator/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/moderator/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
PUT admin/moderator/{moderator}
PATCH admin/moderator/{moderator}
Moderator Delete Data
Requires authentication
Is An Admin-Panel Moderator Data Request That Delete Moderators Data From Database .
Example request:
curl -X DELETE \
"/admin/moderator/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/moderator/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Deleted Successfully"
}
HTTP Request
DELETE admin/moderator/{moderator}
1.3 Admin Users management
Page Group To manage Users data For The Admin Control Panel .
- View the User Data Ex. Name, Email & Phone etc.
- Filter an existing Users from the Filter Form .
- Manage Users From the Enable & Disable Button .
Users View Page
Requires authentication
Is An Admin-Panel User Page That Views users Data Info .
Form Filter is used to filtering existing Users To get better results .
View users Data Info
-
View the User Data Ex. Name, Email & Phone etc.
-
Manage Users From the Enable & Disable Button .
Example request:
curl -X GET \
-G "/admin/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET admin/user
Users View Page
Requires authentication
Is An Admin-Panel User Page That Views users Data Info .
Form Filter is used to filtering existing Users To get better results .
View users Data Info
-
View the User Data Ex. Name, Email & Phone etc.
-
Manage Users From the Enable & Disable Button .
Example request:
curl -X POST \
"/admin/user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST admin/user
Manage Users From the Enable & Disable Button
Requires authentication
Example request:
curl -X GET \
-G "/admin/user_available/1/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/user_available/1/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
GET admin/user_available/{user}/{is_available}
1.4 Admin Zone management
Page Group To manage Zone data For The Admin Control Panel .
- View the Zone Data Ex. Name, Countries & MANAGE .
- Create New Zones .
- Edit an existing Zones from the Edit Button .
- Delete Zones From the delete Button .
Zones View Page
Requires authentication
Is An Admin-Panel Zone Page That Views Zones Data Info .
View Zones Data Info
- View the Zone Data Ex. Name, Countries & MANAGE .
- Create New Zones for the Site .
- Edit an existing Zones from the Edit Button .
- Delete Zones From the delete Button .
Example request:
curl -X GET \
-G "/admin/zone" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/zone"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Test",
"created_at": "2020-12-29 14:07:43",
"updated_at": "2020-12-29 14:07:43",
"countries": [
{
"id": 2,
"iso": "AL",
"name": "ALBANIA",
"nicename": "Albania",
"iso3": "ALB",
"numcode": 8,
"phonecode": 355,
"pivot": {
"zone_id": 2,
"country_id": 2
}
}
]
}
HTTP Request
GET admin/zone
Zone Create Page
Requires authentication
Is An Admin-Panel Zone Page That Creates Zones To Manage The Web Site Generally .
Example request:
curl -X GET \
-G "/admin/zone/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","Countries":"Alex"}'
const url = new URL(
"/admin/zone/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"Countries": "Alex"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Demo Mato",
"countries": "ALBANIA"
}
HTTP Request
GET admin/zone/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the zone. |
Countries |
string | required | The Countries selected of the zone. |
Zone Store Data
Requires authentication
Is An Admin-Panel Zone Data Request That Stores Zones Data To Database .
Example request:
curl -X POST \
"/admin/zone" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/zone"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
POST admin/zone
Zone Edit Page
Requires authentication
Is An Admin-Panel Zone Page That Edits Zones To Manage The Web Site Generally .
Example request:
curl -X GET \
-G "/admin/zone/1/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","Countries":"Alex"}'
const url = new URL(
"/admin/zone/1/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"Countries": "Alex"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"name": "Demo",
"countries": "ALBANIA"
}
HTTP Request
GET admin/zone/{zone}/edit
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the zone. |
Countries |
string | required | The Countries selected of the zone. |
Zone Update Data
Requires authentication
Is An Admin-Panel Zone Data Request That Updates Zones Data To Database .
Example request:
curl -X PUT \
"/admin/zone/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/zone/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
PUT admin/zone/{zone}
PATCH admin/zone/{zone}
Zone Delete Data
Requires authentication
Is An Admin-Panel Zone Data Request That Delete Zones Data From Database .
Example request:
curl -X DELETE \
"/admin/zone/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/zone/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Deleted Successfully"
}
HTTP Request
DELETE admin/zone/{zone}
1.5 Admin Workplaces management
Page Group To manage Workplaces data For The Admin Control Panel .
- View the Workplaces Data Ex. Title, Count of Products & Created By etc .
Workplaces View Page
Requires authentication
Is An Admin-Panel Workplace Page That Views Workplaces Data Info .
Form Filter is used to filtering existing workplaces To get better results .
View Workplace Data Info
- View the Workplace Data Ex. Title, Count of Products & Created By etc.
Example request:
curl -X GET \
-G "/admin/workplace" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/workplace"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET admin/workplace
Workplaces View Page
Requires authentication
Is An Admin-Panel Workplace Page That Views Workplaces Data Info .
Form Filter is used to filtering existing workplaces To get better results .
View Workplace Data Info
- View the Workplace Data Ex. Title, Count of Products & Created By etc.
Example request:
curl -X POST \
"/admin/workplace" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/workplace"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
POST admin/workplace
Single Workplace Info View Page
Requires authentication
Is An Admin-Panel Page For Single Workplace That Views Workplace Data Info .
- View Products For the Workplace .
- View Products Count For the Single Workplace .
- Every Product In the WorkPlace With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product .
- Filter Search to go through every table data .
Example request:
curl -X GET \
-G "/admin/workplace-info/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/workplace-info/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET admin/workplace-info/{workplace_id}
Single Workplace Team Info View Page
Requires authentication
Is An Admin-Panel Page Workplace Team That Views Workplaces Team Data Info That is assigned to the product to manage into the workplaces .
- invite users with the invite button to manage the product that belongs to the workplace .
- counter users that invited to a certain product .
View Workplace Single Product Team Info & Roles
- View the Workplace Single Product Team Info & Roles Ex. User Name, Products Names That Assigned to the user & User role, etc.
Example request:
curl -X GET \
-G "/admin/1/team/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/1/team/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 7,
"name": "demo",
"phone": "0123456789",
"country_code": 20,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-02-03 21:36:19",
"updated_at": "2020-12-09 01:46:55"
}
HTTP Request
GET admin/{workplace_id}/team/{product_id}
1.6 Admin Leads management
Page Group To manage Leads data For The Admin Control Panel .
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
- Filter an existing Leads from the Filter Form .
- View Leads Stats the Qualified & Un Qualified Buttons .
Leads View Page
Requires authentication
Is An Admin-Panel Lead Page That Views leads Data Info .
Form Filter is used to filtering existing leads To get better results .
View leads Data Info
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
-View Leads Stats the Qualified & Un Qualified Buttons .
Example request:
curl -X GET \
-G "/admin/lead" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/lead"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET admin/lead
Leads View Page
Requires authentication
Is An Admin-Panel Lead Page That Views leads Data Info .
Form Filter is used to filtering existing leads To get better results .
View leads Data Info
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
-View Leads Stats the Qualified & Un Qualified Buttons .
Example request:
curl -X POST \
"/admin/lead" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/lead"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST admin/lead
Single Lead Info View Page
Requires authentication
Is An Admin-Panel Page For Single Lead That Views Lead Data Info .
- View Products For the Lead .
- View Products Count For the Single Lead .
- Every Product In the Lead With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product .
- Filter Search to go through every table data .
Example request:
curl -X GET \
-G "/admin/lead/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/admin/lead/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 9,
"workplace_id": 8,
"user_id": 7,
"name": "Bottels Website Form",
"country_id": null,
"website": "https:\/\/popcorn.com",
"product_id": 11,
"widget_type": "text",
"alignment": "left",
"primary": "#34a853",
"secondary": "#ffffff",
"icon_type": "mdi mdi-phone fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#959a9e",
"bubble_text_color": "#ffffff",
"text_text": "Talk to sales expert now!",
"text_round": 10
}
HTTP Request
GET admin/lead/{lead}
2.1 Users Get Data Behind the scene.
Routes for Getting Data Request for site :
-
Personalize the country phone code.
-
Personalize the country data info.
Personalize User Phone Code
-
Personalize the Country Phone Code for later user at the site EX. +2.
Example request:
curl -X GET \
-G "/phoneCode/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/phoneCode/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"phonecode": 355
}
HTTP Request
GET phoneCode/{code}
Personalize User Country Data info
- Personalize User Country Data info for later user at the site EX. ALBANIA.
Example request:
curl -X GET \
-G "/isoCode/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/isoCode/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"iso": "AL",
"name": "ALBANIA"
}
HTTP Request
GET isoCode/{code}
2.1 Users Home management
Page Group To manage General Data for site.
- View the General Data & Routes After Being Authenticated.
A Users Login View Page
Requires authentication
User Login Page That Authenticates User license to use the site properly With his personalized data and getting his data from our database for him to serve him.
Example request:
curl -X GET \
-G "/" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET /
check
Requires authentication
Example request:
curl -X GET \
-G "/check" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/check"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (302):
null
HTTP Request
GET check
Widget View Page
Requires authentication
Widget View Page That Views Product Widget at any site the did put in and it's so much customizable by the user customize options :
-
The widget colors
-
The widget form date Ex. Name, Phone, Email, And Extra 2 Customizable Fields.
-
The User can change the widget icon easily with the customized Edit widget at the control panel.
-
The User can change the widget Text Message bubble easily with the customized Edit widget at the control panel.
Example request:
curl -X GET \
-G "/widgetView/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/widgetView/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET widgetView/{id}
2.2 Users Users management
Page Group To manage Users data For The Manager Control Panel .
- View the User Data Ex. Name, Email & Phone etc.
- Filter an existing Users from the Filter Form .
- Manage Users From the Enable & Disable Button .
User Profile Page
Requires authentication
Is An User Page That Views User Personal Data Info To The User That user can update it for later use.
View user Data Info
-
View the User Data Ex. Name, Email & Phone etc.
-
Manage User Data Change Ex. Name, Email, Phone & Password.
Example request:
curl -X GET \
-G "/profile" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/profile"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET profile
User Update Data
Requires authentication
User Data Request That Updates User Data To Database.
Example request:
curl -X PUT \
"/profile/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/profile/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
PUT profile/{profile}
PATCH profile/{profile}
Dashboard Page
Requires authentication
Is A Dashboard Page That Shows Lists Of Stats & General Data Of The Site In General That User can view stats and make decisions from the stats brief in front of him to manage the Workplace more efficient.
- Statistics For All The Workplaces.
- Diagrams For Data Of Products.
- Diagrams For Data Of Teams.
- Diagrams For Data Of Leads.
- Counter For Products of All Workplaces.
- Counter For Team of All Workplaces.
- Counter For Leads of All Workplaces.
Example request:
curl -X GET \
-G "/dashboard" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/dashboard"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"user_workplaces_count": 19,
"invited_workplaces_count": 28
}
HTTP Request
GET dashboard
2.3 Users Workplaces management
Page Group To manage Workplaces data For The Manager Control Panel.
- View the Workplaces Data Ex. Title, Count of Products & Created By etc.
Workplaces View Page
Requires authentication
Is An Control Panel Manager Workplace Page That Views Workplaces Data Info.
View Workplaces Data Info :
- View the Workplace Data Ex. Title, Count of Products & Created By etc.
Example request:
curl -X GET \
-G "/workplace" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/workplace"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET workplace
Workplace Create Page
Requires authentication
Is An Control Panel Manager Page That Creates Workplaces To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/workplace/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"demo","timezone":"(GMT+02:00) Cairo","website":"www.demo.com","startday":"Monday"}'
const url = new URL(
"/workplace/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "demo",
"timezone": "(GMT+02:00) Cairo",
"website": "www.demo.com",
"startday": "Monday"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
GET workplace/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the workplace. |
timezone |
string | required | The timezone selected of the workplace. |
website |
string | optional | The website of the workplace. |
startday |
string | required | The startday selected of Week Start ON for the workplace. |
Workplace Store Data
Requires authentication
Is An Control Panel Manager Data Request That Stores Workplaces Data To Database.
Example request:
curl -X POST \
"/workplace" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/workplace"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
POST workplace
Display the specified resource.
Requires authentication
Example request:
curl -X GET \
-G "/workplace/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/workplace/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (401):
{
"message": "Unauthenticated."
}
HTTP Request
GET workplace/{workplace}
Workplaces Edit Page
Requires authentication
Is An Control Panel Manager Page That Edits Workplaces To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/workplace/1/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"demo","timezone":"(GMT+02:00) Cairo","website":"www.demo.com","startday":"Monday"}'
const url = new URL(
"/workplace/1/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "demo",
"timezone": "(GMT+02:00) Cairo",
"website": "www.demo.com",
"startday": "Monday"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
GET workplace/{workplace}/edit
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the workplace. |
timezone |
string | required | The timezone selected of the workplace. |
website |
string | optional | The website of the workplace. |
startday |
string | required | The startday selected of Week Start ON for the workplace. |
Workplace Update Data
Requires authentication
Is An Control Panel Manager Data Request That Updates Workplaces Data To Database.
Example request:
curl -X PUT \
"/workplace/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/workplace/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "PUT",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
PUT workplace/{workplace}
PATCH workplace/{workplace}
Workplace Delete Data
Requires authentication
Is An Control Panel Workplace Data Request That Delete Workplaces Data From Database .
Example request:
curl -X DELETE \
"/workplace/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/workplace/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Deleted Successfully"
}
HTTP Request
DELETE workplace/{workplace}
Invited Workplaces Page
Requires authentication
Is An Control Panel User Page That shows the user The Workplaces That User Invited to.
Example request:
curl -X GET \
-G "/invited_workplaces" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/invited_workplaces"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET invited_workplaces
User Workplaces Page
Requires authentication
Is An Control Panel User Page That shows the user The Workplaces That User Is The Owner.
Example request:
curl -X GET \
-G "/user_workplaces" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/user_workplaces"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET user_workplaces
Single Workplace Team Info View Page
Requires authentication
Is An Control Panel Page Workplace Team That Views Certain Workplace Team Data Info That is assigned to the product to manage into the workplace.
- invite users with the invite button to manage the product that belongs to the workplace.
- counter users that invited to a certain product.
View Workplace Single Product Team Info & Roles
- View the Workplace Single Product Team Info & Roles Ex. User Name, Products Names That Assigned to the user & User role, etc.
Example request:
curl -X GET \
-G "/1/team" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/1/team"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 7,
"name": "demo",
"phone": "0123456789",
"country_code": 20,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-02-03 21:36:19",
"updated_at": "2020-12-09 01:46:55"
}
HTTP Request
GET {workplace_id}/team
Single Workplace Team Info View Page
Requires authentication
Is An Control Panel Page Workplace Team That Views Certain Workplace Team Data Info That is assigned to the product to manage into the workplace.
- invite users with the invite button to manage the product that belongs to the workplace.
- counter users that invited to a certain product.
View Workplace Single Product Team Info & Roles
- View the Workplace Single Product Team Info & Roles Ex. User Name, Products Names That Assigned to the user & User role, etc.
Example request:
curl -X GET \
-G "/1/team/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/1/team/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 7,
"name": "demo",
"phone": "0123456789",
"country_code": 20,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-02-03 21:36:19",
"updated_at": "2020-12-09 01:46:55"
}
HTTP Request
GET {workplace_id}/team/{product_id}
User Invite To Product Page
Requires authentication
Is An Control Panel User Page That Invites user To Product And assign a role To work in the product with it.
Example request:
curl -X GET \
-G "/invite/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/invite/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "User invited To Product Successfully"
}
HTTP Request
GET invite/{workplace}
User Invite To Product Request
Requires authentication
Is An Control Panel User Request That Invites users To Product And assign a role To work in the product with it.
Example request:
curl -X POST \
"/invite_member_workplace" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","products":"Product","role":0}'
const url = new URL(
"/invite_member_workplace"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"products": "Product",
"role": 0
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "User invited To Product Successfully"
}
HTTP Request
POST invite_member_workplace
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | optional | The email of the workplace. |
products |
string | required | The products selected That Assigned To User. |
role |
integer | required | The role selected of User permission on certin product. |
Edit User Role
Requires authentication
Is An Control Panel User Request That Updates User Role To Database.
Example request:
curl -X POST \
"/edit_user_role" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/edit_user_role"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Role Updated Successfully"
}
HTTP Request
POST edit_user_role
User Workplaces Remove Request
Requires authentication
Is An Control Panel User Request That Removes user From Workplaces.
Example request:
curl -X GET \
-G "/remove_user_from_workspace/1/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/remove_user_from_workspace/1/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "User Removed From The workspace Successfully"
}
HTTP Request
GET remove_user_from_workspace/{user_id}/{workplace_id}
User Workplaces active Request
Requires authentication
Is An Control Panel User Request That actives user From Workplaces.
Example request:
curl -X GET \
-G "/active_user_in_workspace/1/1/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/active_user_in_workspace/1/1/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "User actived At workspace Successfully"
}
HTTP Request
GET active_user_in_workspace/{status}/{user_id}/{workplace_id}
2.4 Users WorkPlace Products Management
Page Group To manage Single WorkPlaces Individually For The Manager Control Panel And Give him full access for its all features.
-
add product for workplace.
-
Add Team members to the team that is working in the product.
-
manage team behavior From changing the role for every person on the team in the product Ex. owner , Sales Agent.
-
add lead sources for every product in the workplace.
-
Every Product In the WorkPlace With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product.
-
Filter Search to go through every table data.
-
manage every lead source from the Edit page.
Single Workplace Info View Page
Requires authentication
Is An Control Panel Manager Workplace Page That Views Workplace Products Info.
-
View Products For the Workplace.
-
View The Team That Works For the Workplace At every Product Individually.
-
Manage The Team That Works For the Workplace At every Product Individually.
-
View Products Count For the Single Workplace.
-
Manage Single every Product Individually At The Workplace.
-
Every Product In the WorkPlace With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product.
-
Filter Search to go through every table data.
Example request:
curl -X GET \
-G "/product" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/product"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET product
Product Create Page
Requires authentication
Is An Control Panel Manager Page That Creates Products To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/product/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"demo","users":"demo,test"}'
const url = new URL(
"/product/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "demo",
"users": "demo,test"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
GET product/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the Product. |
users |
string | required | The users selected to The Team Managing the product. |
Product Store Data
Requires authentication
Is An Control Panel Manager Data Request That Stores Products Data To Database.
Example request:
curl -X POST \
"/product" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"demo","users":"demo,test"}'
const url = new URL(
"/product"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "demo",
"users": "demo,test"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
POST product
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the Product. |
users |
string | required | The users selected to The Team Managing the product. |
Single Product Info View Page
Requires authentication
Is An Control Panel Page For Single Product That Views Product Data Info.
- View Members For The Team that is working in the product with info data of them Ex. Name,Email & Phone.
Example request:
curl -X GET \
-G "/product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 9,
"name": "test",
"email"<EMAIL_ADDRESS>"phone": "0123456789",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07"
}
HTTP Request
GET product/{product}
Product Edit Page
Requires authentication
Is An Control Panel Manager Page That Edits Products To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/product/1/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"Demo"}'
const url = new URL(
"/product/1/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Demo"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
GET product/{product}/edit
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the Product. |
Product Update Data
Requires authentication
Is An Control Panel Manager Data Request That Updates Products Data To Database.
Example request:
curl -X PUT \
"/product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"Demo"}'
const url = new URL(
"/product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "Demo"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Updated Successfully"
}
HTTP Request
PUT product/{product}
PATCH product/{product}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the Product. |
Product Delete Data
Requires authentication
Is An Control Panel Product Data Request That Delete Products Data From Database .
Example request:
curl -X DELETE \
"/product/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/product/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "DELETE",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Deleted Successfully"
}
HTTP Request
DELETE product/{product}
Single Workplace Info View Page
Requires authentication
Is An Control Panel Manager Workplace Page That Views Workplace Products Info.
-
View Products For the Workplace.
-
View The Team That Works For the Workplace At every Product Individually.
-
Manage The Team That Works For the Workplace At every Product Individually.
-
View Products Count For the Single Workplace.
-
Manage Single every Product Individually At The Workplace.
-
Every Product In the WorkPlace With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product.
-
Filter Search to go through every table data.
Example request:
curl -X GET \
-G "/1/products" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/1/products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday",
"products_count": 5,
"users_count": 5,
"leads_count": 12
}
HTTP Request
GET {workplace_id}/products
Product Create Page
Requires authentication
Is An Control Panel Manager Page That Creates Products To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/product/create/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"title":"demo","users":"demo,test"}'
const url = new URL(
"/product/create/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"title": "demo",
"users": "demo,test"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
GET product/create/{workplace_id}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
title |
string | required | The title of the Product. |
users |
string | required | The users selected to The Team Managing the product. |
Product Invite Member Request
Requires authentication
Is An Control Panel Product Data Request That Invites Members To the team of the product To manage it later on .
Example request:
curl -X POST \
"/invite_member" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/invite_member"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Member added Successfully"
}
HTTP Request
POST invite_member
Product Invite Member Widget
Requires authentication
Is An Control Panel Product Data Widget That Invites Members To the team of the product To manage it later on .
Example request:
curl -X POST \
"/choose_members" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/choose_members"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Member added Successfully"
}
HTTP Request
POST choose_members
Invite Member To certain product
Requires authentication
Is An Control Panel Product Data Request That Invites Members To the team of the product To manage it later on .
Example request:
curl -X POST \
"/add_product_to_user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/add_product_to_user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Product has been Added successfully"
}
HTTP Request
POST add_product_to_user
2.5 Users Lead Sources management
Page Group To manage Single Lead Sources For The Manager Control Panel And Give him full access for its all features.
-
Add lead sources for every product in the workplace.
-
Every lead sources With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Management pages forevery lead source Ex. View , Add & Edit.
-
Filter Search to go through every table data.
-
manage every lead source from the Edit Widget page.
-
View Widget lead source from the view Widget page.
-
Add Widget lead source from the Add Widget page.
Single Lead Source Info View Page
Requires authentication
Page Group To manage Single Lead Sources For The Manager Control Panel And Give him full access for its all features.
- Add lead sources for every product in the workplace.
- Every lead sources With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Management pages forevery lead source Ex. View , Add & Edit.
- Filter Search to go through every table data.
- Add Widget lead source from the Add Widget page.
- View Widget lead source from the view Widget page.
- manage every lead source from the Edit Widget page.
Example request:
curl -X GET \
-G "/sources" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/sources"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"workplace_id": 7,
"user_id": 2,
"name": "demo",
"country_id": 1,
"website": "https:\/\/demo.com",
"widget_type": "icon",
"alignment": "right",
"primary": "#a83434",
"secondary": "#ffffff",
"icon_type": "mdi mdi-headset fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#000000",
"bubble_text_color": "#ffffff",
"text_text": "Talk to an expert!",
"text_round": 10,
"custom_lable_1": "phone",
"custom_lable_2": "age",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07"
}
HTTP Request
GET sources
Lead Source Create Page
Requires authentication
Is An Control Panel Manager Page That Creates Lead Source To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/sources/create" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"workplace_id":"7","name":"demo","website":"https:\/\/demo.com","widget_type":"icon","alignment":"right","primary":"#a83434","secondary":"#ffffff","icon_type":"mdi mdi-headset fa-fw","bubble":"on","bubble_line_1":"Want to talk to an expert?","bubble_line_2":"Our Team is 60 Second Away From You!","bubble_bg_color":"#000000","bubble_text_color":"#ffffff","text_text":"Talk to an expert!","text_round":"10","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/sources/create"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"workplace_id": "7",
"name": "demo",
"website": "https:\/\/demo.com",
"widget_type": "icon",
"alignment": "right",
"primary": "#a83434",
"secondary": "#ffffff",
"icon_type": "mdi mdi-headset fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#000000",
"bubble_text_color": "#ffffff",
"text_text": "Talk to an expert!",
"text_round": "10",
"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
GET sources/create
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
workplace_id |
string | required | The workplace_id selected to add lead source to workplace. |
name |
string | required | The name of the lead source. |
website |
string | required | The website of the lead source. |
widget_type |
string | optional | The widget_type selected to icon Widget. |
alignment |
string | optional | The alignment selected to right Widget. |
primary |
string | optional | The primary Pick to color to Widget. |
secondary |
string | optional | The secondary Pick to color to Widget. |
icon_type |
string | optional | The icon_type style to Widget. |
bubble |
string | optional | The bubble selected to on Widget. |
bubble_line_1 |
string | optional | The bubble_line_1 typed to on Widget. |
bubble_line_2 |
string | optional | The bubble_line_2 typed to on Widget. |
bubble_bg_color |
string | optional | The bubble_bg_color Pick to color to Widget. |
bubble_text_color |
string | optional | The bubble_text_color Pick to color to Widget. |
text_text |
string | optional | The text_text typed to on Widget. |
text_round |
string | optional | The text_round selected to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Lead Source Store Data
Requires authentication
Is An Control Panel Manager Data Request That Stores Lead Sources Data To Database.
Example request:
curl -X POST \
"/sources" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"workplace_id":"7","name":"demo","website":"https:\/\/demo.com","widget_type":"icon","alignment":"right","primary":"#a83434","secondary":"#ffffff","icon_type":"mdi mdi-headset fa-fw","bubble":"on","bubble_line_1":"Want to talk to an expert?","bubble_line_2":"Our Team is 60 Second Away From You!","bubble_bg_color":"#000000","bubble_text_color":"#ffffff","text_text":"Talk to an expert!","text_round":"10","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/sources"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"workplace_id": "7",
"name": "demo",
"website": "https:\/\/demo.com",
"widget_type": "icon",
"alignment": "right",
"primary": "#a83434",
"secondary": "#ffffff",
"icon_type": "mdi mdi-headset fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#000000",
"bubble_text_color": "#ffffff",
"text_text": "Talk to an expert!",
"text_round": "10",
"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Added Successfully"
}
HTTP Request
POST sources
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
workplace_id |
string | required | The workplace_id selected to add lead source to workplace. |
name |
string | required | The name of the lead source. |
website |
string | required | The website of the lead source. |
widget_type |
string | optional | The widget_type selected to icon Widget. |
alignment |
string | optional | The alignment selected to right Widget. |
primary |
string | optional | The primary Pick to color to Widget. |
secondary |
string | optional | The secondary Pick to color to Widget. |
icon_type |
string | optional | The icon_type style to Widget. |
bubble |
string | optional | The bubble selected to on Widget. |
bubble_line_1 |
string | optional | The bubble_line_1 typed to on Widget. |
bubble_line_2 |
string | optional | The bubble_line_2 typed to on Widget. |
bubble_bg_color |
string | optional | The bubble_bg_color Pick to color to Widget. |
bubble_text_color |
string | optional | The bubble_text_color Pick to color to Widget. |
text_text |
string | optional | The text_text typed to on Widget. |
text_round |
string | optional | The text_round selected to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Lead Source Edit Page
Requires authentication
Is An Control Panel Manager Page That Edits Lead Source To Manage It later on the site by the manager and his team.
Example request:
curl -X GET \
-G "/sources/1/edit" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"workplace_id":"7","name":"demo","website":"https:\/\/demo.com","widget_type":"icon","alignment":"right","primary":"#a83434","secondary":"#ffffff","icon_type":"mdi mdi-headset fa-fw","bubble":"on","bubble_line_1":"Want to talk to an expert?","bubble_line_2":"Our Team is 60 Second Away From You!","bubble_bg_color":"#000000","bubble_text_color":"#ffffff","text_text":"Talk to an expert!","text_round":"10","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/sources/1/edit"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"workplace_id": "7",
"name": "demo",
"website": "https:\/\/demo.com",
"widget_type": "icon",
"alignment": "right",
"primary": "#a83434",
"secondary": "#ffffff",
"icon_type": "mdi mdi-headset fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#000000",
"bubble_text_color": "#ffffff",
"text_text": "Talk to an expert!",
"text_round": "10",
"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Edited Successfully"
}
HTTP Request
GET sources/{source}/edit
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
workplace_id |
string | required | The workplace_id selected to add lead source to workplace. |
name |
string | required | The name of the lead source. |
website |
string | required | The website of the lead source. |
widget_type |
string | optional | The widget_type selected to icon Widget. |
alignment |
string | optional | The alignment selected to right Widget. |
primary |
string | optional | The primary Pick to color to Widget. |
secondary |
string | optional | The secondary Pick to color to Widget. |
icon_type |
string | optional | The icon_type style to Widget. |
bubble |
string | optional | The bubble selected to on Widget. |
bubble_line_1 |
string | optional | The bubble_line_1 typed to on Widget. |
bubble_line_2 |
string | optional | The bubble_line_2 typed to on Widget. |
bubble_bg_color |
string | optional | The bubble_bg_color Pick to color to Widget. |
bubble_text_color |
string | optional | The bubble_text_color Pick to color to Widget. |
text_text |
string | optional | The text_text typed to on Widget. |
text_round |
string | optional | The text_round selected to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Lead Source Update Data
Requires authentication
Is An Control Panel Manager Data Request That Updates Lead Sources Data To Database.
Example request:
curl -X PUT \
"/sources/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"workplace_id":"7","name":"demo","website":"https:\/\/demo.com","widget_type":"icon","alignment":"right","primary":"#a83434","secondary":"#ffffff","icon_type":"mdi mdi-headset fa-fw","bubble":"on","bubble_line_1":"Want to talk to an expert?","bubble_line_2":"Our Team is 60 Second Away From You!","bubble_bg_color":"#000000","bubble_text_color":"#ffffff","text_text":"Talk to an expert!","text_round":"10","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/sources/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"workplace_id": "7",
"name": "demo",
"website": "https:\/\/demo.com",
"widget_type": "icon",
"alignment": "right",
"primary": "#a83434",
"secondary": "#ffffff",
"icon_type": "mdi mdi-headset fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#000000",
"bubble_text_color": "#ffffff",
"text_text": "Talk to an expert!",
"text_round": "10",
"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "PUT",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "Edited Successfully"
}
HTTP Request
PUT sources/{source}
PATCH sources/{source}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
workplace_id |
string | required | The workplace_id selected to add lead source to workplace. |
name |
string | required | The name of the lead source. |
website |
string | required | The website of the lead source. |
widget_type |
string | optional | The widget_type selected to icon Widget. |
alignment |
string | optional | The alignment selected to right Widget. |
primary |
string | optional | The primary Pick to color to Widget. |
secondary |
string | optional | The secondary Pick to color to Widget. |
icon_type |
string | optional | The icon_type style to Widget. |
bubble |
string | optional | The bubble selected to on Widget. |
bubble_line_1 |
string | optional | The bubble_line_1 typed to on Widget. |
bubble_line_2 |
string | optional | The bubble_line_2 typed to on Widget. |
bubble_bg_color |
string | optional | The bubble_bg_color Pick to color to Widget. |
bubble_text_color |
string | optional | The bubble_text_color Pick to color to Widget. |
text_text |
string | optional | The text_text typed to on Widget. |
text_round |
string | optional | The text_round selected to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
2.6 Users Manager Leads management
Page Group To manage Leads data For The Manager Control Panel .
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
- Filter an existing Leads from the Filter Form.
- View Leads Stats the Qualified & Un Qualified Buttons.
Leads View Page
Requires authentication
Is An Control Panel Lead Page That Views leads Data Info .
Form Filter is used to filtering existing leads To get better results .
View leads Data Info
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
-View Leads Stats the Qualified & Un Qualified Buttons .
Example request:
curl -X GET \
-G "/leads" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/leads"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
GET leads
Leads View Page
Requires authentication
Is An Control Panel Lead Page That Views leads Data Info .
Form Filter is used to filtering existing leads To get better results .
View leads Data Info
- View the Leads Data Ex. Lead Name, Workplace Product belongs to & Product etc.
-View Leads Stats the Qualified & Un Qualified Buttons .
Example request:
curl -X POST \
"/leads" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/leads"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST leads
Single Lead Info View Page
Requires authentication
Is An Control Panel Page For Single Lead That Views Lead Data Info .
- View Products For the Lead.
- View Products Count For the Single Lead.
- Every Product In the Lead With its Stats Ex. Leads Source Name, Leads count, Contacted Leads Count & Team Names That Assigned to this Product.
- Filter Search to go through every table data.
Example request:
curl -X GET \
-G "/leads/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/leads/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 9,
"workplace_id": 8,
"user_id": 7,
"name": "Bottels Website Form",
"country_id": null,
"website": "https:\/\/popcorn.com",
"product_id": 11,
"widget_type": "text",
"alignment": "left",
"primary": "#34a853",
"secondary": "#ffffff",
"icon_type": "mdi mdi-phone fa-fw",
"bubble": "on",
"bubble_line_1": "Want to talk to an expert?",
"bubble_line_2": "Our Team is 60 Second Away From You!",
"bubble_bg_color": "#959a9e",
"bubble_text_color": "#ffffff",
"text_text": "Talk to sales expert now!",
"text_round": 10
}
HTTP Request
GET leads/{lead}
2.7 Users Product Widget management
Page Group To manage Widget View & Submission of the form.
- View the Leads Widget Form Ex. Name, Email, Phone, And another two customizable fields.
- Submit the Leads Widget Form To The database.
Widget Form Page
Requires authentication
Is An Leads Page That Submit Widget To leads To Manage by the manager and his team Later On.
- View the Leads Widget Form Ex. Name, Email, Phone, And another two customizable fields.
Example request:
curl -X GET \
-G "/widget/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","phone":"demo,test","Email":"phone","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/widget/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"phone": "demo,test",
"Email": "phone",
"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "You Have Submitted Succesfully,Thanks."
}
HTTP Request
GET widget/{id}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | optional | The name of the Product. |
phone |
string | required | The phone selected to The Team Managing the product. |
Email |
string | optional | The Email typed to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Widget Form Request
Requires authentication
Is An Leads Request That Submit Widget To leads by the manager and his team Later On.
-
View the Leads Widget Form Ex. Name, Email, Phone, And another two customizable fields.
-
Submit the Leads Widget Form To The database.
Example request:
curl -X POST \
"/widgetView/widget" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","phone":"demo,test","Email":"test@demo.com","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/widgetView/widget"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"phone": "demo,test",
"Email"<EMAIL_ADDRESS>"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "You Have Submitted Succesfully,Thanks."
}
HTTP Request
POST widgetView/widget
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | optional | The name of the Product. |
phone |
string | required | The phone selected to The Team Managing the product. |
Email |
string | optional | The Email typed to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
3.1 APIs User management
Page Group To manage Users data From APIs.
- Get the User Data Ex. Name, Email & Phone etc.
- validator to validate the User Data Ex. Name, Email & Phone etc For Login.
- Login The User To An App.
- Update UserData.
User Login
Requires authentication
User Data Request That Login User To the app and give him access if the validation was right To the app.
Example request:
curl -X POST \
"/api/login" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","password":"*****"}'
const url = new URL(
"/api/login"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"password": "*****"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST api/login
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | The email of the user. |
password |
string | required | The password of the user. |
User Login Ar
Requires authentication
User Data Request That Login User To the app and give him access if the validation was right To the app.
Example request:
curl -X POST \
"/api/login1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"email":"test@demo.com","password":"*****"}'
const url = new URL(
"/api/login1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"email"<EMAIL_ADDRESS>"password": "*****"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST api/login1
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
email |
string | required | The email of the user. |
password |
string | required | The password of the user. |
User Register
Requires authentication
User Data Request That Register User To the app and give him access if the validation was right To the app.
Example request:
curl -X POST \
"/api/login2" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","email":"test@demo.com","phone":"123456","country_code":"+20","password":"******"}'
const url = new URL(
"/api/login2"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"email"<EMAIL_ADDRESS>"phone": "123456",
"country_code": "+20",
"password": "******"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST api/login2
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
string | required | The phone of the user. |
country_code |
string | required | The country_code of the user. |
password |
string | required | The password of the user. |
User Edit Request
Requires authentication
User Data Request That Edit User Data To the app .
Example request:
curl -X POST \
"/api/update_profile" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","email":"test@demo.com","phone":"123456","country_code":"+20","password":"******"}'
const url = new URL(
"/api/update_profile"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"email"<EMAIL_ADDRESS>"phone": "123456",
"country_code": "+20",
"password": "******"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null,
"is_available": 1,
"products_count": 2,
"workplaces_count": 1,
"leads_count": 7
}
HTTP Request
POST api/update_profile
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | required | The name of the user. |
email |
string | required | The email of the user. |
phone |
string | required | The phone of the user. |
country_code |
string | required | The country_code of the user. |
password |
string | required | The password of the user. |
User Status
Requires authentication
User Data Request That Enables Or Disables User Access To the app .
Example request:
curl -X POST \
"/api/change_is_available" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"user_id":"1","is_available":"1"}'
const url = new URL(
"/api/change_is_available"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"user_id": "1",
"is_available": "1"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "User Profile Edited Succefully"
}
HTTP Request
POST api/change_is_available
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
user_id |
string | required | The user_id of the user. |
is_available |
string | required | The is_available of the user. |
3.2 APIs Workplaces management
Page Group To manage Workplaces data From APIs.
- Get the User Data Ex. Name, Email & Phone etc.
- validator to validate the User Data Ex. Name, Email & Phone etc For Login.
- Login The User To An App.
- Update UserData.
Widget Form Request
Requires authentication
Is An Leads Request That Submit Widget To leads by the manager and his team Later On.
-
View the Leads Widget Form Ex. Name, Email, Phone, And another two customizable fields.
-
Submit the Leads Widget Form To The database.
Example request:
curl -X POST \
"/api/widgetView/widget" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"name":"demo","phone":"demo,test","Email":"test@demo.com","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/api/widgetView/widget"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"name": "demo",
"phone": "demo,test",
"Email"<EMAIL_ADDRESS>"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "You Have Submitted Succesfully,Thanks."
}
HTTP Request
POST api/widgetView/widget
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
name |
string | optional | The name of the Product. |
phone |
string | required | The phone selected to The Team Managing the product. |
Email |
string | optional | The Email typed to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Create Lead Request
Requires authentication
Is An Leads Request That Submit leads For Certin Product for the manager and his team Later On.
- Submit the Leads To The database.
Example request:
curl -X POST \
"/api/lead" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"product_id":"5","name":"demo","phone":"demo,test","Email":"test@demo.com","custom_lable_1":"phone","custom_lable_2":"age"}'
const url = new URL(
"/api/lead"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"product_id": "5",
"name": "demo",
"phone": "demo,test",
"Email"<EMAIL_ADDRESS>"custom_lable_1": "phone",
"custom_lable_2": "age"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"success": "YRequest Has been Sent Successfully"
}
HTTP Request
POST api/lead
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
product_id |
string | optional | The product_id of the Product. |
name |
string | optional | The name of the Product. |
phone |
string | required | The phone selected to The Team Managing the product. |
Email |
string | optional | The Email typed to on Widget. |
custom_lable_1 |
string | optional | The custom_lable_1 typed to on Widget. |
custom_lable_2 |
string | optional | The custom_lable_2 typed to on Widget. |
Get Workplaces Request
Requires authentication
Is An Api Request To Get All Workplaces Data.
Example request:
curl -X GET \
-G "/api/all_workplaces" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/all_workplaces"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"admin_id": 7,
"title": "Sherkat",
"created_at": "2020-02-14 23:08:32",
"updated_at": "2020-06-21 07:21:07",
"timezone": "Africa\/Cairo",
"website": null,
"startday": "Monday"
}
HTTP Request
GET api/all_workplaces
Get Products Request
Requires authentication
Is An Api Request To Get All Products Data Of A certin Workplace.
Example request:
curl -X POST \
"/api/all_products" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"workplace_id":"5"}'
const url = new URL(
"/api/all_products"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"workplace_id": "5"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 1,
"name": "demo",
"phone": "01234567890",
"country_code": null,
"email"<EMAIL_ADDRESS>"email_verified_at": null,
"created_at": "2020-01-26 16:26:56",
"updated_at": "2021-01-07 13:35:48",
"device_token": null,
"os": null
}
HTTP Request
POST api/all_products
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
workplace_id |
required | optional | string The workplace_id of the Product. |
Get Leads Request
Requires authentication
Is An Api Request To Get All Leads Data.
Example request:
curl -X GET \
-G "/api/all_leads" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/all_leads"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"name": "Demo",
"phone": "1234567654",
"product_id": "6",
"mobile": "22345678987654"
}
HTTP Request
GET api/all_leads
Get User Leads Request
Requires authentication
Is An Api Request To Get All Leads Data Of A Certin User.
Example request:
curl -X GET \
-G "/api/user_leads/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"user_id":"5"}'
const url = new URL(
"/api/user_leads/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"user_id": "5"
}
fetch(url, {
method: "GET",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"name": "Demo",
"phone": "1234567654",
"product_id": "6",
"mobile": "22345678987654"
}
HTTP Request
GET api/user_leads/{user}
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
user_id |
required | optional | string The user_id of the Product. |
Lead Status Edit Request
Requires authentication
Is An Api Request To Edit All Lead Status.
Example request:
curl -X POST \
"/api/qualified" \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-d '{"id":"5","status":"1"}'
const url = new URL(
"/api/qualified"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
let body = {
"id": "5",
"status": "1"
}
fetch(url, {
method: "POST",
headers: headers,
body: body
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"id": 2,
"status": 1
}
HTTP Request
POST api/qualified
Body Parameters
| Parameter | Type | Status | Description |
|---|---|---|---|
id |
required | optional | string The id of the Product. |
status |
required | optional | string The status of the Product. |
api/test_notification_user
Requires authentication
Example request:
curl -X POST \
"/api/test_notification_user" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/test_notification_user"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/test_notification_user
api/test_notification_device
Requires authentication
Example request:
curl -X POST \
"/api/test_notification_device" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/test_notification_device"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/test_notification_device
general
Reset Password Request
Requires authentication
Reset Password User By Sending Request To The Email Registered At The website To Reset password.
- We will send the password reset link to this user. Once we have attempted to send the link, we will examine the response then see the message we need to show to the user. Finally, we'll send out a proper response.
Example request:
curl -X POST \
"/api/password/email" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/password/email"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
{
"msg_en": "sent Successfully",
"msg_ar": "تم الارسال بنجاح"
}
HTTP Request
POST api/password/email
Reset the given user's password.
Example request:
curl -X POST \
"/api/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/api/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST api/password/reset
Display the form to request a password reset link.
Example request:
curl -X GET \
-G "/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET password/reset
Send a reset link to the given user.
Example request:
curl -X POST \
"/password/email" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/password/email"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST password/email
Display the password reset view for the given token.
If no token is present, display the link request form.
Example request:
curl -X GET \
-G "/password/reset/1" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/password/reset/1"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "GET",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
Example response (200):
null
HTTP Request
GET password/reset/{token}
Reset the given user's password.
Example request:
curl -X POST \
"/password/reset" \
-H "Content-Type: application/json" \
-H "Accept: application/json"
const url = new URL(
"/password/reset"
);
let headers = {
"Content-Type": "application/json",
"Accept": "application/json",
};
fetch(url, {
method: "POST",
headers: headers,
})
.then(response => response.json())
.then(json => console.log(json));
HTTP Request
POST password/reset


{%extends "base/errors_base.html"%} {%block content%}
The server encountered something unexpected that didn't allow it to complete the request. We apologize. You can go back to main page: Home