- This CRM Service API revolves round the user complaints(issue raised by the user through the ticket creation) and the tracking of those issue status.
- User SignUp(Registration) and SignIn Functionality
- Admin registration will be from the backend directly.(For testing purpose, doing it, from the veryFirst time server started) Though, the ADMIN user creation request are taken and send it with response as BAD REQUEST status.
- Engineer registration will be supported through API, but it needs to be approved by the ADMIN to signIn successfully into the system.
- Customer registration will be supported through API with no approval needed from the ADMIN.
- API to support the ADMIN/CUSTOMER/ENGINEER signIn. SignIn will be successfull in case of users with APPROVED userStatus . Successfull SignIn API call should return the access token, which will be used by the concerned user to make all the other calls on the protected endpoints.
- On ticket creation by the user, an engineer (with approved status) will be auto assigned the ticket. In case,by any chance , no approved engineer is available during ticket creation,Ticket will still be created,and assignee will be Null for that ticket for the timeperiod .And we are sending the mail notification, to the admin also for every ticket creation, so immediately admin can have a look and assing an engineer by approving a engineer.
- On ticket creation and updation, a email will be send automatically to all the concerned users of those tickets .This has been done with the help of another notificationService API, which has been integrated with this crmService.
- Tickets and users can be queried based on various optional query Parameters.Only the concerned user will get the results of those that they are authorised for.
- ADMIN has all the rights.
- Customer has the rights related to ticket created by own.
- Engineer has the rights with the tickets created or tickets assigned.
- On sucessfull updation of ticketStatus, repsective engineeraffected property will also be updated internally.
- Only the ADMIN can change the assignee of the ticket.
- There is one restriction on the ADMIN too, admin can't change the assingee and ticketStatus at same time, as it may result inconsitency over the data.
The whole code base is arranged in multiple directories and files. Project follows Models, Controllers, Routes (MCR Architecture Pattern), to arrange the code.
- Models directory contain files dealing with the defining the database Schemas.
- Controllers directory contain files dealing with handling the core business logic.
- Routes directory contain the files managing with the routes.
- Middlewares directory to define all middlewares(generally related for validating incoming requests).
- Utils directory contains the files that have reusable code(functions).
- Configs directory for all configs file to configure all the configurations realted to server,database and authentication.
- The main startup file is "server.js".
CRM Service API, uses a number of open source projects (all are npm packages) to work properly:
- Express- Express is a web framework for node. Using it to create a server and managing dofferent routes.
- bcryptjs - For hashing the secret credentials of the user and verifying them.
- dotenv - Dotenv to load environment variables from a .env file into process.env
- jsonwebtoken -For creating access token and verifying them.
- mongoose - Mongoose is a MongoDB object modeling tool designed to work in an asynchronous environment.
- node-rest-client - Allows connecting to any API REST and get results as js Object. In our case, using it to connect to notificationService API.
- nodemon -Dev Dependency,Used as tool that helps developing Node.js based applications by automatically restarting the node application when file changes in the directory are detected. Can skip the devDepedency by changing the scripts properties values in package.json file.
- this app requires Node.js(Runtime Environment) v16+ and mongodb v5+(Database, for persistance of data) to run.
cd crmServiceAPI
npm installBefore running the app locally, ensure to copy env.sample file and change it to .env and rewrite all your configuration variables value over there.Incase running in production,ensure to configre those variables first in production and change the scripts property value under package.json file accordingly.
IMPORTANT NOTE-This App integrated with a notification service app, to send email notification asynchronously to the concerned members of the ticket on ticket creation and updation. So before running this app,ensure to configure and run the notification service API
- To make crmServiceAPI is up and running in your machine, follow the below steps after all configuration and related dependecies installation done.
cd crmServiceAPI
npm startExpress application,CRM Service API will up and running on configured port.
POST /crmService/api/v1/auth/signup
Sample request body :
{
"name":"CUSTOMER2",
"userId":"customer2",
"email":"customer2@email.com",
"password":"crmService@1"
}
Sample response body :
{
"success": true,
"data": {
"name": "CUSTOMER2",
"email": "customer2@email.com",
"userId": "customer2",
"userType": "CUSTOMER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:23.673Z",
"updatedAt": "2022-08-05T12:35:23.673Z"
}
}Details about the JSON structure (Request Body)
- name : Mandatory
- userId : Manadatory and Unique
- email : Manadatory and Unique
- passworod : Mandatory and must have minimum 10 characters, having at least 1 uppercase alphabet, 1 lowercase alphabet, 1 digit and 1 special character.
- userType : Optional, default value is CUSTOMER. Allowed values : ADMIN | ENGINEER | CUSTOMER
- userStatus : It reperesents the status of the registered user. Customer are by default approved.Engineers need approval from Admin.If any User status updated to ADMIN,then userStatus for that user will become PENDING irrespective of its previousu userstatus So Only Authorised ADMIN(With approved Status) can approve status of any newADMIN or Engineer, so to allow the user into the system. Allowed values : APPROVED | PENDING | REJECTED
POST /crmService/api/v1/auth/signin
Sample request body :
{
"userId":"customer2",
"password":"crmService@1"
}
Sample response body :
{
"success": true,
"data": {
"name": "CUSTOMER2",
"email": "customer2@email.com",
"userId": "customer2",
"userType": "CUSTOMER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:23.673Z",
"updatedAt": "2022-08-05T12:35:23.673Z",
"accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImN1c3RvbWVyMiIsImlhdCI6MTY1OTcwMzM5OCwiZXhwIjoxNjU5NzA2OTk4fQ.vL0ChGOh3hVNSglDJ8KagOngLZD7sibcXGf1yVhP9SQ"
}
}- Every User will get the accessToken after successfull signIn ,so to allow user to pass that token as x-access-token in headers along with request, instead of sending user credentials (like userId and password) to authenticate and authorized the user request on protected endpoints.If token verfied , then only user allowed to access the restricted resource data.
3. Get all Users details, Request (Only ADMIN WITH Approved Status ALLOWED,TO get all the users details)
GET /crmservice/api/v1/users
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzAyOTQ3LCJleHAiOjE2NTk3MDY1NDd9.Bo_55aJrEGg7vLUr1pCJg4Iu2ZTMHEWLsYUo0J86KTc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"documentResultsCount": 5,
"data": [
{
"name": "John Doe",
"email": "john@email.com",
"userId": "admin",
"userType": "ADMIN",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:34:23.045Z",
"updatedAt": "2022-08-05T12:34:23.045Z",
"ticketsWorkingOnCount": 0
},
{
"name": "CUSTOMER1",
"email": "customer1@email.com",
"userId": "customer1",
"userType": "CUSTOMER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:12.920Z",
"updatedAt": "2022-08-05T12:35:12.920Z"
},
{
"name": "CUSTOMER2",
"email": "customer2@email.com",
"userId": "customer2",
"userType": "CUSTOMER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:23.673Z",
"updatedAt": "2022-08-05T12:35:23.673Z"
},
{
"name": "ENGINEER1",
"email": "engineer1@email.com",
"userId": "engineer1",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:30.038Z",
"updatedAt": "2022-08-05T12:36:07.906Z",
"ticketsWorkingOnCount": 0
},
{
"name": "ENGINEER2",
"email": "engineer2@email.com",
"userId": "engineer2",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:41.216Z",
"updatedAt": "2022-08-05T12:36:11.657Z",
"ticketsWorkingOnCount": 0
}
]
}
- ADMIN User may pass optional queryParameter, while sending the GET all users request, to filter the response.QueryParameter taken into account are -userStatus amd userType.
4. Get all Users details BASED on Optional QueryParameter, Request (Only ADMIN WITH Approved Status ALLOWED,TO get all the users details)
GET /crmservice/api/v1/users?userType=<value>&userStatus=<value>
GET /crmservice/api/v1/users?userType=ENGINEER (EXAMPLE)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzAyOTQ3LCJleHAiOjE2NTk3MDY1NDd9.Bo_55aJrEGg7vLUr1pCJg4Iu2ZTMHEWLsYUo0J86KTc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"documentResultsCount": 2,
"data": [
{
"name": "ENGINEER1",
"email": "engineer1@email.com",
"userId": "engineer1",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:30.038Z",
"updatedAt": "2022-08-05T12:36:07.906Z",
"ticketsWorkingOnCount": 0
},
{
"name": "ENGINEER2",
"email": "engineer2@email.com",
"userId": "engineer2",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:41.216Z",
"updatedAt": "2022-08-05T12:36:11.657Z",
"ticketsWorkingOnCount": 0
}
]
}5. Get specific user based on userId, Request (Only ADMIN and the Concerend User(with approved Status), allowed to get specific user details)
GET /crmService/api/v1/users/:userId
GET /crmService/api/v1/users/engineer1 (Example)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzAyOTQ3LCJleHAiOjE2NTk3MDY1NDd9.Bo_55aJrEGg7vLUr1pCJg4Iu2ZTMHEWLsYUo0J86KTc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"data": {
"name": "ENGINEER1",
"email": "engineer1@email.com",
"userId": "engineer1",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:35:30.038Z",
"updatedAt": "2022-08-05T12:36:07.906Z",
"ticketsWorkingOnCount": 0
}
}6. Update specific user based on userId(passed as a request params), Request (Only ADMIN and the Concerend User(with approved Status), allowed to update user details)
PUT /crmService/api/v1/users/:userId
PUT /crmService/api/v1/users/engineer3 (EXAMPLE)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzAyOTQ3LCJleHAiOjE2NTk3MDY1NDd9.Bo_55aJrEGg7vLUr1pCJg4Iu2ZTMHEWLsYUo0J86KTc
Sample request body :
{
"userStatus":"APPROVED"
}
Sample response body :
{
"success": true,
"data": {
"name": "ENGINEER3",
"email": "engineer3@email.com",
"userId": "engineer3",
"userType": "ENGINEER",
"userStatus": "APPROVED",
"createdAt": "2022-08-05T12:51:10.499Z",
"updatedAt": "2022-08-05T12:51:48.093Z",
"ticketsWorkingOnCount": 0
}
}POST /crmservice/api/v1/tickets
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImN1c3RvbWVyMSIsImlhdCI6MTY1OTcwNDA3OCwiZXhwIjoxNjU5NzA3Njc4fQ.atlYh08btee-HN91sE9zkGPsnZx33nCWYk-8A0B_ZNM
Sample request body :
{
"title":"Problem in printer",
"description":"Printer is not working, showing error 254 while printing and stopped."
}
Sample response body :
{
"success": true,
"message": "Ticket successfully created."
}
Details about the JSON structure (Request Body)
- title : Mandatory
- description : Manadatory
- ticketPriority : Optional, default value is 4. Allowed values and their denotion priority : 4 -low | 3-medium | 2-high | 1-extreme
- Ticket reporter value(useId) will be taken from the user details who requested the ticketCreation request.
- Ticket will be auto assigned to an approved engineer having least number of ticketsWorkingOnCount.
- Ticket Status ,will be auto assigned status as "OPEN" on ticket Creation. (Other allowed values of ticket Status are - BLOCKED | CLOSED).
- As , the notifcationService is integrated with the CRMService, so sending the mail(auto-mail) to all concerened Users, request will be also taken care by the notificationService after successfull ticketCreation.
GET /crmservice/api/v1/tickets
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzA0MTk2LCJleHAiOjE2NTk3MDc3OTZ9.2R0nRRNAqEP9oZj0hiMnKkZXRTB69AQ7ONcJfNHTxKc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"documentResultsCount": 3,
"data": [
{
"_id": "62ed134ee134ad67c6c61e68",
"title": "Problem in printer",
"ticketPriority": 4,
"description": "Printer is not working, showing error 254 while printing and stopped.",
"status": "OPEN",
"reporter": "customer1",
"assignee": "engineer1",
"createdAt": "2022-08-05T12:55:42.348Z",
"updatedAt": "2022-08-05T12:55:42.348Z"
},
{
"_id": "62ed13d3e134ad67c6c61e75",
"title": "Problem in mobile phone",
"ticketPriority": 4,
"description": "Mobile phone is not working, restarting automatically after 5 minute of usage.",
"status": "OPEN",
"reporter": "customer1",
"assignee": "engineer2",
"createdAt": "2022-08-05T12:57:55.314Z",
"updatedAt": "2022-08-05T12:57:55.314Z"
},
{
"_id": "62ed140be134ad67c6c61e80",
"title": "Problem in mobile phone",
"ticketPriority": 4,
"description": "Mobile phone is not working, restarting automatically after 10 minute of usage.",
"status": "OPEN",
"reporter": "customer2",
"assignee": "engineer3",
"createdAt": "2022-08-05T12:58:51.352Z",
"updatedAt": "2022-08-05T12:58:51.352Z"
}
]
}- User with Admin userType (with approved status) can get all the tickets details.
- User with Engineer userType, can get only those tickets details that are either assigned to or created by the concerned user.
- Through this, an engineer can easily fetch all those tickets assigned to him/her and by passing optional queryParams ,can get quickly the data based on the given query.
- User with Customer userType , can get only those tickets details that are created by the concerned user.
- Optional QueryParams are- Status,reporter,assignee,ticketPriority,title,description For title and description queryParams, it returns all those documents containing that query value text.
GET /crmservice/api/v1/tickets?status=<value>&reporter=<reporter>&assignee=<value>&ticketPriority=<value>&title=<value>&description=<value>
GET /crmservice/api/v1/tickets?status=OPEN&description=PRINTER (EXAMPLE)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzA0MTk2LCJleHAiOjE2NTk3MDc3OTZ9.2R0nRRNAqEP9oZj0hiMnKkZXRTB69AQ7ONcJfNHTxKc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"documentResultsCount": 1,
"data": [
{
"_id": "62ed134ee134ad67c6c61e68",
"title": "Problem in printer",
"ticketPriority": 4,
"description": "Printer is not working, showing error 254 while printing and stopped.",
"status": "OPEN",
"reporter": "customer1",
"assignee": "engineer1",
"createdAt": "2022-08-05T12:55:42.348Z",
"updatedAt": "2022-08-05T12:55:42.348Z"
}
]
}10. Update specific ticket based on ticketId(passed as a request params), Request (Only ADMIN and the Concerend User(with approved Status), allowed to update ticket details)
PUT /crmService/api/v1/tickets/:ticketId
PUT /crmservice/api/v1/tickets/62ed134ee134ad67c6c61e68 (EXAMPLE)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImVuZ2luZWVyMSIsImlhdCI6MTY1OTcwNTU3NiwiZXhwIjoxNjU5NzA5MTc2fQ.nbGk5DssjZTkoUlo6wBcDlJbpLSAnLhND2lj4ODrwcU
Sample request body :
{
"status":"CLOSED"
}
Sample response body :
{
"success": true,
"message": "Ticket successfully updated."
}- Based on update request , there are several behind the actions (usually updation on the concerned document) taken.
- For updation of ticket status from OPEN TO CLOSED/BLOCKED , the concerned ticket has been updated and also assigned engineer - ticketsWorkingCount decremented by 1.
- In case of ticket assigneee changed from one engineer to another engineer , ticketAssigned property value affected for both concerned engineers(concerned ticket pop out from previous assigned engineer ticketsAssigned details and push to another engineer ticketsAssigned details).
- Also in case of changing assignee for a ticket with Open status, ticketsWorkingCount from previousAssignedEngineer decremented by 1 and incremented by 1 for the newAsssigned Engineer.
- In case, tickets status is CLOSED or BLOCKED, then ticketsWorkingCount doesnt affect for both engineers.
11. Get specific ticket details based on ticketId, Request (Only ADMIN and the Concerend User(with approved Status), allowed to get specific ticket details)
GET /crmService/api/v1/tickets/:ticketId
GET /crmservice/api/v1/tickets/62ed134ee134ad67c6c61e68 (Example)
Headers :
Content-Type:application/json
x-access-token:eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6ImFkbWluIiwiaWF0IjoxNjU5NzAyOTQ3LCJleHAiOjE2NTk3MDY1NDd9.Bo_55aJrEGg7vLUr1pCJg4Iu2ZTMHEWLsYUo0J86KTc
Sample request body : <EMPTY>
Sample response body :
{
"success": true,
"data": {
"_id": "62ed134ee134ad67c6c61e68",
"title": "Problem in printer",
"ticketPriority": 4,
"description": "Printer is not working, showing error 254 while printing and stopped.",
"status": "CLOSED",
"reporter": "customer1",
"assignee": "engineer1",
"createdAt": "2022-08-05T12:55:42.348Z",
"updatedAt": "2022-08-05T13:20:40.752Z"
}
}12. Any request of anytype on invalid endpoint , that doesnt exists, will send response status 404 NOTFOUND with proper response message
GET|POST|PUT|DELETE /crmService/api/v1/InvalidEndPoint
DELETE /crmservice/api/v1/tickets/62ed134ee134ad67c6c61e68 (Example)
Sample request body : <EMPTY>
Sample response body :
{
"success": "false",
"message": "The requested endpoint doesn't exists."
}
- For all the request on protected endpoints, the validation has been taken care of, in case the validation not passed in any phase in the request processing pipeline, the proper response has been sent back from there only, without considering the request further into the processing pipeline.
Have suggestions for improvement. Do make the changes and raise a PR. Reach out to me over devkeycode@gmail.com