Welcome to the API documentation for the Anonymous Feedback Web Application!\nThis API enables the collection of anonymous feedback from end-users through a secure and privacy-focused process. Here's a step-by-step overview of how the application works:
\ntopicId.tokenId and topicId.tokenId and topicId, authenticated end-users can submit their feedback anonymously through the API. Crucially, no email address is associated with the submitted feedback or the tokens within the system, ensuring complete anonymity.topicId, without any ability to trace the feedback back to individual email addresSimple get request to check/verify if the backend is alive.
\n","urlObject":{"protocol":"http","port":"5000","path":[""],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"d720e3e0-4f97-4cd8-ba53-8ebc395d49a6","name":"test resopnse","originalRequest":{"method":"GET","header":[],"url":"http://localhost:5000/"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"40","enabled":true},{"key":"ETag","value":"W/\"28-gM1p3JVEQEDBluOTvZsBaJZ/Dz0\"","enabled":true},{"key":"Date","value":"Sun, 20 Apr 2025 19:31:37 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Hello world\"\n}"}],"_postman_id":"1cd381ad-a896-4613-9484-32143c70128e"},{"name":"create an admin account","id":"42cb3aa5-b0a8-4812-bace-f18ea12fc70a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"name\":\"Prashant Swaroop\",\r\n \"email\":\"admin@gmail.com\",\r\n \"password\":\"Adminhu@001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/auth/createAccount","description":"Description:
Endpoint to create a new administrator account. All fields are mandatory for successful registration.
Description:\nEndpoint to log in an existing administrator and receive access and refresh tokens.
\nKey Points:
\nSet-Cookie header as an HttpOnly cookie named refreshToken. This token is used to obtain new access tokens without requiring the user to log in again.Request Body:
\n```json\n{\n \"email\": \"admin@example.com\",\n \"password\": \"yourpassword\"\n}
\n","urlObject":{"protocol":"http","port":"5000","path":["auth","login"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"ce1a0a17-598e-41b4-9ced-5ad2f68da78d","name":"login res","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"admin@gmail.com\",\r\n \"password\":\"Adminhu@001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/auth/login"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Set-Cookie","value":"refreshToken=f3d382ac-516f-4ffb-86f7-de16b3505370; Max-Age=86400; Path=/; Expires=Mon, 21 Apr 2025 19:40:21 GMT; HttpOnly; SameSite=Strict","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"293","enabled":true},{"key":"ETag","value":"W/\"125-Gy7HoeCV96pP3HqLtKvvOOCFq5c\"","enabled":true},{"key":"Date","value":"Sun, 20 Apr 2025 19:40:21 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Logged in successfully\",\n \"accessToken\": \"{{vault:json-web-token}}\"\n}"}],"_postman_id":"e89a1fad-e98d-4305-8447-1a3d5c08c6ee"},{"name":"logout","id":"688a02e1-57bd-4bbf-87f8-760af42a443d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"admin@gmail.com\",\r\n \"password\":\"Adminhu@001\"\r\n}","options":{"raw":{"language":"json"}}},"url":"http://localhost:5000/auth/logout","description":"Description:
\nUse this POST request to log out the current administrator.
Requires: The refreshToken to be included in the Cookie header of the request.
Outcome: Upon successful logout, the refreshToken will be invalidated.
Result: The administrator will need to log in again to access protected resources.
\nDescription:
Endpoint to create a new feedback topic.
Authentication:
\nRequires a valid Bearer Token or Authorization Token to be present in the request headers.
\nIf no valid token is provided, the request will be rejected with an authentication error
\nDescription:\nThis critical endpoint allows administrators to upload a list of users (via CSV or plain text representing CSV data) who are invited to provide feedback for a specific topic.
\nAuthentication:
\nPath Parameter:
\n{topicId} (integer, required): The ID of the topic for which these email addresses are being invited to provide feedback.Request Body (multipart/form-data):
\nfile (file, required): The file containing the list of users to invite..csv (Comma Separated Values) and .txt (plain text representing CSV values).name, email, topicId.name (string, optional): The name of the user.email (string, required): The email address of the user to be invited.topicId (integer, required): The ID of the topic for which this user is being invited (should match the {topicId} in the path).Important Notes:
\nfile in a multipart/form-data request..csv) and plain text files representing CSV data (.txt) are accepted.name, email, topicId). Ensure the headers (if present) match this order or are omitted if the file contains only data rows. The topicId in the file must correspond to the {topicId} provided in the URL path.Description:
This endpoint is used to obtain a new access token when the current one has expired.
Authentication:
* Requires a valid `refreshToken` to be present in the `Cookie` header of the request.
* If a valid `refreshToken` is found, a new `accessToken` will be issued.
* If no `refreshToken` is found or if it is invalid or expired, the request will be rejected.
Request Headers:
\n* `Cookie`: Must contain the `refreshToken` cookie obtained during login
\n","urlObject":{"protocol":"http","port":"5000","path":["auth","refresh-token"],"host":["localhost"],"query":[],"variable":[]}},"response":[{"id":"a1559914-404b-4885-bdcf-42b466362736","name":"success refresh token","originalRequest":{"method":"POST","header":[],"url":"http://localhost:5000/auth/refresh-token"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"X-Powered-By","value":"Express","enabled":true},{"key":"Access-Control-Allow-Origin","value":"*","enabled":true},{"key":"Content-Type","value":"application/json; charset=utf-8","enabled":true},{"key":"Content-Length","value":"299","enabled":true},{"key":"ETag","value":"W/\"12b-bVfcrBm6C2azEApuowCxYSlOvfA\"","enabled":true},{"key":"Date","value":"Mon, 21 Apr 2025 14:54:55 GMT","enabled":true},{"key":"Connection","value":"keep-alive","enabled":true},{"key":"Keep-Alive","value":"timeout=5","enabled":true}],"cookie":[],"responseTime":null,"body":"{\n \"success\": true,\n \"message\": \"Token generated successfully\",\n \"accessToken\": \"{{vault:json-web-token}}\"\n}"}],"_postman_id":"99ac2803-5e7b-49aa-87ac-8702213fc6cb"},{"name":"send Emails","id":"aea65831-c96c-4ed1-904d-224c2c6585e9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"basicConfig":[{"key":"token","value":"{{vault:authorization-secret}}"}]},"isInherited":false},"method":"POST","header":[],"url":"http://localhost:5000/email/sendEmails/7","description":"Description:
This endpoint triggers the sending of invitation emails to all the email addresses that have been previously uploaded for a specific feedback topic.
Authentication:
\nRequires a valid Bearer Token or Authorization Token to be present in the request headers.
\nIf no valid token is provided, the request will be rejected with an authentication error.
\nPath Parameter:
\n{topicId} (integer, required): The ID of the topic for which invitation emails should be sent.Request Body:
(No request body is typically required for this action, as it operates on the emails already associated with the specified topicId.)
Description:
This endpoint allows end-users to verify their invitation using their email address and the unique token they received.
Successful verification will grant them access to submit feedback for the associated topic.
Description:
This endpoint allows verified end-users to submit their feedback for a specific topic. The tokenId and topicId obtained during the verification process are required to ensure the feedback is associated with the correct invitation.
Authentication:
\ntokenId and topicId to be included in the request body. These are obtained after successful verification via the /api/user/verify endpoint.