SmartApp Backend Development

BackEnd_Development

AppSetup/AppRole
AppSetup/Apps
AppSetup/Others
AppSetup/Roles
Data
MasterData
OrgSetup/Branch
OrgSetup/Business Areas
OrgSetup/Company
User (Auth)/Create Users
User (Auth)/User Data
- Get App List for User
- Update Branch of an User
User (Auth)/User Login
Utilities
- Send Email

AppSetup/AppRole 7

Get AppRole List | GET {{URL}}/api/v1/approles

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get list of companies using SmartApp.

Signature: // @desc Get all companies // @route GET /api/v1/companies // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get AppRole Details | GET {{URL}}/api/v1/approles/5ea0a66d89cec35a119054d2

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get dedails of one company using SmartApp.

Signature: // @desc Get single company // @route GET /api/v1/companies/:id // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

raw

Create Role | POST {{URL}}/api/v1/approles

Description

Overview: Apps are used for Business Transactions within SmartApp.

API Usage: This API can be used to create new App for SmartApp.

Signature: // @desc Create new app // @route POST /api/v1/apps // @access Private (Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "appRole": "Manager", "icon": "sap-icon://incident", "inUse": true, "status":"New", "app":["SUPP00001", "SUPP00003"] }

raw

Update Role | PUT {{URL}}/api/v1/approles/5ea0a65489cec35a119051d4

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Update company // @route PUT /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "role":"Approver" }

formdata

Delete Role | DELETE {{URL}}/api/v1/roles/5e9e29eeb4195ac280cee1c6

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Delete company // @route DELETE /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

formdata

Upload photo for App | PUT {{URL}}/api/V1/roles/5e9e2a2eb4195ac280cee1c8/photo

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

Upload Documents for App | PUT /api/v1/companies/:id/document

Description

Title: Upload documents for the company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company documents(PDF, Word, Excel, Text).

Signature: // @desc Upload documents for the company // @route PUT /api/v1/companies/:id/document // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

AppSetup/Apps 7

Get App List | GET {{URL}}/api/V1/apps/

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get list of companies using SmartApp.

Signature: // @desc Get all companies // @route GET /api/v1/companies // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

Query

Key	Value	Description
limit	5
page	2

Get App Details | GET {{URL}}/api/V1/apps/5e9deeb3b9ab75bc95ec4483

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get dedails of one company using SmartApp.

Signature: // @desc Get single company // @route GET /api/v1/companies/:id // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

raw

Create App | POST {{URL}}/api/v1/apps

Description

Overview: Apps are used for Business Transactions within SmartApp.

API Usage: This API can be used to create new App for SmartApp.

Signature: // @desc Create new app // @route POST /api/v1/apps // @access Private (Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "applicationID": "SUPP00004", "descriptions":[ { "Language":"EN", "appDescription":"Supplier Invoice App", "area": "Purchasing", "module": "Supplier Self Service" } ], "dataStore": "mongoDB", "icon": "sap-icon://incident", "inUse": true, "status":"New" }

raw

Update App | PUT {{URL}}/api/V1/apps/5e9deeb3b9ab75bc95ec4483

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Update company // @route PUT /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "area":"Enterprise-Purchasing" }

formdata

Delete App | DELETE {{URL}}/api/V1/apps/5e9df27db9ab75bc95ec4487

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Delete company // @route DELETE /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

formdata

Upload photo for App | PUT {{URL}}/api/V1/apps/5ea035706b8787431690bdbc/photo

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

Upload Documents for App | PUT /api/v1/companies/:id/document

Description

Title: Upload documents for the company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company documents(PDF, Word, Excel, Text).

Signature: // @desc Upload documents for the company // @route PUT /api/v1/companies/:id/document // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

AppSetup/Others 3

raw

Add App Schema | POST {{URL}}/api/v1/appschema

Description

/api/v1/appschema

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "appID": "ERP00002", "schemaApp": "Employee" }

raw

Get App Schema Copy | GET {{URL}}/api/v1/appschema

Description

/api/v1/appschema

Headers

Key	Value	Description
Content-Type	application/json	JSON

raw

Add Validation Rule | POST {{URL}}/api/v1/validationrule

Description

Add Validation Rule

/api/v1/validationrule

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "rule":"UKPOSTCODE_VALIDATION", "type":"regEx", "value":"xxx" }

AppSetup/Roles 7

Get Role List | GET {{URL}}/api/V1/roles/

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get list of companies using SmartApp.

Signature: // @desc Get all companies // @route GET /api/v1/companies // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get Role Details | GET {{URL}}/api/v1/roles/5e9e2a2eb4195ac280cee1c8

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get dedails of one company using SmartApp.

Signature: // @desc Get single company // @route GET /api/v1/companies/:id // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

raw

Create Role | POST {{URL}}/api/v1/roles

Description

Overview: Apps are used for Business Transactions within SmartApp.

API Usage: This API can be used to create new App for SmartApp.

Signature: // @desc Create new app // @route POST /api/v1/apps // @access Private (Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "role": "Manager", "descriptions":[ { "Language":"EN", "appDescription":"Manager Role", "appHelp":"Approve - Request for Access Card", "area":"ERP" } ], "icon": "sap-icon://incident", "inUse": true, "status":"New" }

raw

Update Role | PUT {{URL}}/api/v1/roles/5e9e3aaa7706e8c528e94cf2

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Update company // @route PUT /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "area":"Enterprise-Purchasing2" }

formdata

Delete Role | DELETE {{URL}}/api/v1/roles/5e9e29eeb4195ac280cee1c6

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Delete company // @route DELETE /api/v1/companies/:id // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

formdata

Upload photo for App | PUT {{URL}}/api/V1/roles/5e9e2a2eb4195ac280cee1c8/photo

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

Upload Documents for App | PUT /api/v1/companies/:id/document

Description

Title: Upload documents for the company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company documents(PDF, Word, Excel, Text).

Signature: // @desc Upload documents for the company // @route PUT /api/v1/companies/:id/document // @access Private

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

Data 7

Get Adaptive Card | GET {{URL}}/api/v1/cards

raw

Create Records - EDU00097 | POST {{URL}}/api/v1/datarecords/

Headers

Key	Value	Description
Content-Type	application/json	JSON
applicationid	EDU00097

Body

{ "ID":"100003", "Status":"Requested", "StudentName":"Anita Jain", "StudentID":"A0044", "Email":"ramesh@yahoo.co.uk", "BookingFor":"ParentAppointment", "StudyYear":"Year6", "Section":"A", "TeacherName":"Mr. King", "Date":"2020-04-29", "Comment":"For Maths and English", "ParentName":"Mahesh D", "ParentEmail":"parent@smartphonebizapps.com" }

raw

Create Records - EMPACC01 - LaptopRequest | POST {{URL}}/api/v1/datarecords/

Headers

Key	Value	Description
Content-Type	application/json	JSON
applicationid	EMPACC01

Body

{ "ID":"900002", "Status":"Requested", "Email":"ramesh@yahoo.co.uk", "Reason":"My Laptop Not Working", "Name":"Atul", "Surname":"Gupta", "RequestType":"LaptopRequest", "DateOfRequest":"2020-04-29", "EmployeeID":"12002" }

raw

Create Records - EMPBOK01 - CarPark Booking | POST {{URL}}/api/v1/datarecords/

Headers

Key	Value	Description
Content-Type	application/json	JSON
applicationid	EMPBOK01

Body

{ "ID":"500003", "Status":"Requested", "Email":"ramesh@yahoo.co.uk", "Reason":"CarPark Booking for Visitor", "CarPark":"BristolOfficeCarPark", "FirstName":"Atul", "LastName":"Gupta", "RequestType":"LaptopRequest", "StartDate":"2020-04-30", "EndDate":"2020-04-30", "EmployeeID":"12002", "CarRegistration":"BD51 SMR" }

raw

Create Records - EMP00006 - Training Request | POST {{URL}}/api/v1/datarecords/

Headers

Key	Value	Description
Content-Type	application/json	JSON
applicationid	EMP00006

Body

{ "ID":"500004", "Status":"Approved", "Email":"ramesh@yahoo.co.uk", "EmployeeID":"12002", "DateRequested":"2020-04-30", "Detail":"SAP MM Training", "External":true, "EmpDev":true, "ProjectNeed":true, "Name":"Atul Gupta", "Cost":580, "Currency":"GBP", "ProjectCode":"RG-300-790", "Justification":"Training is required for current Project delivery", "Duration": "1 Weeks" }

raw

EDU00097 Data List | GET {{URL}}/api/v1/listrecords/EDU00097

Headers

Key	Value	Description
Content-Type	application/json	JSON
businessrole	Student

raw

EMP00006 Data List | GET {{URL}}/api/v1/listrecords/EMP00006

Headers

Key	Value	Description
Content-Type	application/json	JSON
businessrole	Employee

MasterData 3

raw

MaintainMasterData | POST {{URL}}/api/v1/employee/records

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "ID":"100001" "company": "5e9f1743f5cf01dabb80e85f", "companyName": "SmartPhone Biz Apps Ltd", "branch": "5e9f3100b5164ade3249b622", "branchName": "SmartPhone Biz Apps, UK", "userId": "5e9cc6182ab6d99a07f5d125", "EmployeeID":"1000", "Name":"Atul Gupta" }

raw

DataSave | POST {{URL}}/api/v1/employee/records

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "ID":"400015", "applicationID":"EDU00003", "transactionID":123124, "companyName": "SmartPhone Biz Apps Ltd", "branchName": "SmartPhone Biz Apps, UK", "areaName": "Consulting", "EmployeeID":"1000", "Name":"Atul Gupta", "postcode":"SL1 9DU", "email":"atul@smart.com", "SortCode":"JG103759A" }

formdata

CSVUpload | POST {{URL}}/api/v1/employee/records/csvupload

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

Key	Value	Description
file

OrgSetup/Branch 8

Get Branch List | GET {{URL}}/api/V1/companies/5e9da9521cb6cbb17f302845/branches

Description

Overview: Branch is second level entity for SmartApp, Branch can be used to define access level for users. As an example: Company: XYZ Ltd Branch: XYZ London Office, XYZ Mumbai Office, XYZ Paris Office etc..

API Usage: This API can be used to get list of branches for a company using SmartApp.

Signature: // @desc Get branches // @route GET /api/v1/branches // @route GET /api/v1/companies/:companyId/branches // @access Private (Any one in the Company)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get Branch | GET {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd

Description

API Usage: This API can be used to get the details of a branch for a company using SmartApp.

Signature: // @desc Get single branch // @route GET /api/v1/branches/:id // @access Private (Any one in the Company)

raw

Create Branch | POST {{URL}}/api/v1/companies/5e9f1743f5cf01dabb80e85f/branches

Description

API Usage: This API can be used to create a branch for a company using SmartApp.

Signature: // @desc Add branch // @route POST /api/v1/companies/:companyId/branches // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "branchName": "SmartPhone Biz Apps, UK", "website": "https://smartphonebizapps.com/", "phone": "(+44) 7850342883", "email": "atul@smartphonebizapps.com", "address": "47,Lower Cippenham Lane, Slough, Berkshire, SL15DG, GB", "sector": "IT", "status":"New" }

raw

Update Branch | PUT {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd

Description

API Usage: This API can be used to update branch for a company using SmartApp.

Signature: // @desc Update branch // @route PUT /api/v1/branches/:id // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "branchName": "SmartPhone Biz Apps Ltd India" }

Delete Branch | DELETE {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd

Description

API Usage: This API can be used to delete branch for a company using SmartApp.

Signature: // @desc Delete branch // @route DELETE /api/v1/branches/:id // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get branches within a radius | GET {{URL}}/api/v1/branches/radius/470002/1000

Description

Title: Get branches within a radius

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to find branch withing specified radius.

Signature: // @desc Get branches within a radius // @route GET /api/v1/branches/radius/:zipcode/:distance // @access Private(Anyone within Company)

Headers

Key	Value	Description
Content-Type	application/json	JSON

formdata

Upload photo for branch | PUT {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd/photo

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

Key	Value	Description
file

Upload documents for branch | PUT {{URL}}/api/v1/branches/:id/document

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

OrgSetup/Business Areas 7

Get Business Area | GET {{URL}}/api/V1/companies/5e9da9521cb6cbb17f302845/branches

Description

Overview: Business Area is second level entity for SmartApp, Business Area can be used to define access level for users. As an example: Company: XYZ Ltd Business Area: Purchasing, Sales, R&D, Marketing etc..

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Get branches // @route GET /api/v1/branches // @route GET /api/v1/companies/:companyId/branches // @access Private (Any one in the Company)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get Business Area | GET {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd

Description

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Get single branch // @route GET /api/v1/branches/:id // @access Private (Any one in the Company)

raw

Create Business Area | POST {{URL}}/api/v1/companies/5e9f1743f5cf01dabb80e85f/areas

Description

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Add branch // @route POST /api/v1/companies/:companyId/branches // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "areaName": "Consulting", "description": "SmartApp Product Development", "status":"New" }

raw

Update Branch | PUT {{URL}}/api/v1/branches/5e9dbd1a08ed7eb59cd887cd

Description

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Update branch // @route PUT /api/v1/branches/:id // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "branchName": "SmartPhone Biz Apps Ltd India" }

Delete Company | DELETE {{URL}}/api/v1/branches/:id

Description

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Delete branch // @route DELETE /api/v1/branches/:id // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get branches within a radius | GET {{URL}}/api/v1/branches/radius/470002/1000

Description

Title: Find Business Area within Radius (This may not be required!!)

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Get branches within a radius // @route GET /api/v1/branches/radius/:zipcode/:distance // @access Private(Anyone within Company)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Upload documents for branch | PUT {{URL}}/api/v1/branches/:id/document

Description

Title: Upload documents for Business Area

API Usage: This API can be used to get list of Business Area for a company using SmartApp.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

OrgSetup/Company 9

Get Company List | GET {{URL}}/api/v1/companies

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get list of companies using SmartApp.

Signature: // @desc Get all companies // @route GET /api/v1/companies // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get a Company | GET {{URL}}/api/V1/companies/5e9f1743f5cf01dabb80e85f

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to get dedails of one company using SmartApp.

Signature: // @desc Get single company // @route GET /api/v1/companies/:id // @access Public

Headers

Key	Value	Description
Content-Type	application/json	JSON

raw

Update Company | PUT {{URL}}/api/v1/companies/5e9dca830bf528b820f74ab6

Description

API Usage: This API can be used to update branch for a company using SmartApp.

Signature: // @desc Update branch // @route PUT /api/v1/branches/:id // @access Private(Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "branchName": "SmartPhone Biz Apps Ltd India" }

raw

Create a Company | POST {{URL}}/api/V1/companies/

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to create one company SmartApp.

Signature: // @desc Create new company // @route POST /api/v1/companies // @access Private (Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "companyName": "SmartPhone Biz Apps Ltd", "website": "https://smartphonebizapps.com/", "phone": "(+44) 7850342883", "email": "atul@smartphonebizapps.com", "address": "47,Lower Cippenham Lane, Slough, Berkshire, SL15DG, GB", "sector": "IT", "subSector":"Consulting", "status":"New" }

Delete Company | DELETE {{URL}}/api/V1/companies/5e9f0dadf5cf01dabb80e85e

Description

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to update a company.

Signature: // @desc Delete company // @route DELETE /api/v1/companies/:id // @access Private (Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON

Get companies within a radius | GET {{URL}}/api/v1/companies/radius/TA8/50

Description

Title: Get companies within a radius

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to find company withing specified radius.

Signature: // @desc Get companies within a radius // @route GET /api/v1/companies/radius/:zipcode/:distance // @access Private (Admin)

formdata

Upload photo for company | PUT {{URL}}/api/V1/companies/5e9dca830bf528b820f74ab6/photo

Description

Title: Upload photo for company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company phots and pics.

Signature: // @desc Upload photo for company // @route PUT /api/v1/companies/:id/photo // @access Private (Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E
file

Body

Key	Value	Description
file

Upload Documents for company | PUT /api/v1/companies/:id/document

Description

Title: Upload documents for the company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company documents(PDF, Word, Excel, Text).

Signature: // @desc Upload documents for the company // @route PUT /api/v1/companies/:id/document // @access Private (Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

Upload Documents for company Copy | PUT /api/v1/companies/:id/document

Description

Title: Upload logo for the company

Overview: Company is the top level entity for SmartApp, any businesses data is consolidated max upto Company Level(Top Level).

API Usage: This API can be used to upload company documents(PDF, Word, Excel, Text).

Signature: // @desc Upload logo for the company // @route PUT /api/v1/companies/:id/logo // @access Private (Company Admin)

Headers

Key	Value	Description
Content-Type	application/json	JSON
file

User (Auth)/Create Users 3

raw

Create User | POST {{URL}}/api/v1/auth/register

Description

This API can be used for create or register new user for SmartApp Important Information: userType: internal or external

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "name":"SmartApp Supper Admin", "email":"admin@smartphonebizapps.com", "role":"user", "password":"London2020", "userType":"internal", "userAccess":"SuperAdmin" }

raw

Add Roles to User | PUT {{URL}}/api/v1/users/5e9cc6182ab6d99a07f5d125

Description

This API can be used for create or register new user for SmartApp Important Information: userType: internal or external

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "businessRoles":["User", "Employee","Technician"] }

raw

Update User | PUT {{URL}}/api/v1/auth/updatedetails

Description

Update User Details

Body

{ "name":"Atul Gupta", "email":"atul_gup@yahoo.co.uk", "company":"5e9f1743f5cf01dabb80e85f", "branch":"5e9f3100b5164ade3249b622", "area":"5e9f3b7d9d8df8e0115cbee2" }

User (Auth)/User Data 2

Get App List for User | GET {{URL}}/api/v1/userapps

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization

raw

Update Branch of an User | PUT {{URL}}/api/v1/auth/updatebranch

Description

Update Branch of an User

Body

{"branch":""}

User (Auth)/User Login 6

raw

User Login | POST {{URL}}/api/v1/auth/login

Description

This API can be used for user login authentication for SmartApp

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "email":"atul_gup@yahoo.co.uk", "password":"London2021" }

raw

Get LoggedIn user / User from Token | POST {{URL}}/api/v1/auth/me

Description

Get Logged In user from Token

Headers

Key	Value	Description
Content-Type	application/json	JSON
Authorization	Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjVlOWNjNjE4MmFiNmQ5OWEwN2Y1ZDEyNSIsImlhdCI6MTU4NzM5MDQ0NiwiZXhwIjoxNTg5OTgyNDQ2fQ.KQz0NfA6i1FiNuGYSI_pZnF_xeVIMFg79qpYu8hKX4E

Body

{ "email":"atul_gup@yahoo.co.uk" }

raw

Forgot Password | POST {{URL}}/api/v1/auth/forgotpassword

Description

Overview: This API can be used to send password reset emails from SmartApp (noreply@smartphonebizapps.com)

API Usage: This API can be used to send password reset emails from SmartApp App or BOTs.

Important Note: For development and testing purposes we will set smtp.mailtrap.io as the test mail server. This will make testing very easy and we can create users with dummy Emails for our testing

Steps for Testing using MailTrap server: Steps to access emails during the testing are : - Login to Gmail using gst@smartphonebizapps.com - Got to MailTrap site (https://mailtrap.io/) - Login with Google Account and then select gst@smartphonebizapps.com - Now ifyou send any email from SmartApp BOT or App using this API for any sender all emails can be viewed on mailTrap

Additional Notes: With the password reset email a token is sent which is valid only for 10 mins. user need to action in within 10 mins and reset the password. otherwise token will be expired. Example URL with Token is: {{URL}}/api/v1/auth/resetpassword/609ce738d4ae4379c7cb149f0f4a3f94afa7cf25

Signature: // @desc Forgot password // @route POST /api/v1/auth/forgotpassword // @access Public (anyone can request for password reset, if they have valid ID then they will be able to do it) // @header Content-Type = application/json // @body JSON { “email”:“atul_gup@yahoo.co.uk”

}

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{"email":"atul_gup@yahoo.co.uk"}

raw

PIN based Login | POST {{URL}}/api/v1/auth/pinLogin

Description

Overview: This API can be used to send password reset emails from SmartApp (noreply@smartphonebizapps.com)

API Usage: This API can be used to send password reset emails from SmartApp App or BOTs.

Important Note: For development and testing purposes we will set smtp.mailtrap.io as the test mail server. This will make testing very easy and we can create users with dummy Emails for our testing

}

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{"email":"atul_gup@yahoo.co.uk"}

raw

Reset Password | PUT {{URL}}/api/v1/auth/resetpassword/fc14ec0406d645ec1f5f336635176f7d76ebed27

Description

Overview: This API can be used to reset password from SmartApp (noreply@smartphonebizapps.com)

API Usage: This API can be used to Reset Password from SmartApp App or BOTs.

Important Note: For development and testing purposes we will set smtp.mailtrap.io as the test mail server. This will make testing very easy and we can create users with dummy Emails for our testing

Signature: // @desc Reset password // @route PUT /api/v1/auth/resetpassword/:resettoken // @access Public (all valid users can reset their password) // @header Content-Type = application/json // @body JSON { “password”:“XYZ12345” }

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "password":"London2021" }

raw

Check PIN | PUT {{URL}}/api/v1/auth/resetpassword/6a879fba97bc9b90db3e2dd49e39a3c45264be43

Description

Overview: This API can be used to reset password from SmartApp (noreply@smartphonebizapps.com)

API Usage: This API can be used to Reset Password from SmartApp App or BOTs.

Important Note: For development and testing purposes we will set smtp.mailtrap.io as the test mail server. This will make testing very easy and we can create users with dummy Emails for our testing

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "password":"449850" }

Utilities 1

raw

Send Email | POST {{URL}}/api/v1/auth/sendemail

Description

Overview: This API can be used to send emails from SmartApp (noreply@smartphonebizapps.com)

API Usage: This API can be used to send emails from SmartApp App or BOTs.

Important Note: For development and testing purposes we will set smtp.mailtrap.io as the test mail server. This will make testing very easy and we can create users with dummy Emails for our testing

Signature: // @desc send an email // @route POST /api/v1/auth/sendEmail // @access Protected (to send an email user should be associated with SmartApp) // @header Content-Type = application/json & Authorization = ‘Bearer ’ + token // @body JSON {

"emailTo":"abc@gmail.com",
"subject":"Test Email",
"message":"This is a test email from SmartApp"

}

Headers

Key	Value	Description
Content-Type	application/json	JSON

Body

{ "emailTo":"rash0474@gmail.com", "subject":"Test Email", "message":"This is a test email from SmartApp" }