{"info":{"_postman_id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","name":"MessageBuzz API","description":"

📄 Get started here

This template contains a boilerplate for documentation that you can quickly customize and reuse.

🔖 How to use this template

Replace the content given brackets (()) with your API's details.
Tips are formatted in codespan - feel free to read and remove them.

Start with a brief overview of what your API offers.

The ((product name)) provides many API products, tools, and resources that enable you to ((add product value here)).

You can also list the APIs you offer, link to the relevant pages, or do both in this section.

Getting started guide

List the steps or points required to start using your APIs. Make sure to cover everything required to reach success with your API as quickly as possible.

To start using the ((add APIs here)), you need to -

The points given below are from The Postman API's documentation. You can reference it to write your own getting started guide.

You must use a valid API Key to send requests to the API endpoints. You can get your API key from Postman's integrations dashboard.
The API has rate and usage limits.
The API only responds to HTTPS-secured communications. Any requests sent via HTTP return an HTTP 301 redirect to the corresponding HTTPS resources.
The API returns request responses in JSON format. When an API request returns an error, it is sent in the JSON response as an error key.

Authentication

Add details on the authorization keys/tokens required, steps that cover how to get them, and the relevant error codes.

The ((product name)) API uses ((add your API's authorization type)) for authentication.

The details given below are from the Postman API's documentation. You can reference it to write your own authentication section.

Postman uses API keys for authentication. You can generate a Postman API key in the API keys section of your Postman account settings.

You must include an API key in each request to the Postman API with the X-Api-Key request header.

Authentication error response

If an API key is missing, malformed, or invalid, you will receive an HTTP 401 Unauthorized response code.

Rate and usage limits

Use this section to cover your APIs' terms of use. Include API limits, constraints, and relevant error codes, so consumers understand the permitted API usage and practices.

The example given below is from The Postman API's documentation. Use it as a reference to write your APIs' terms of use.

API access rate limits apply at a per-API key basis in unit time. The limit is 300 requests per minute. Also, depending on your plan, you may have usage limits. If you exceed either limit, your request will return an HTTP 429 Too Many Requests status code.

Each API response returns the following set of headers to help you identify your use status:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Header	Description
`X-RateLimit-Limit`	The maximum number of requests that the consumer is permitted to make per minute.
`X-RateLimit-Remaining`	The number of requests remaining in the current rate limit window.
`X-RateLimit-Reset`	The time at which the current rate limit window resets in UTC epoch seconds.

503 response

An HTTP 503 response from our servers indicates there is an unexpected spike in API access traffic. The server is usually operational within the next five minutes. If the outage persists or you receive any other form of an HTTP 5XX error, contact support.

Need some help?

Add links that customers can refer to whenever they need help.

In case you have questions, go through our tutorials ((link to your video or help documentation here)). Or visit our FAQ page ((link to the relevant page)).

Or you can check out our community forum, there’s a good chance our community has an answer for you. Visit our developer forum ((link to developer forum)) to review topics, ask questions, and learn from others.

You can also document or add links to libraries, code examples, and other resources needed to make a request.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"📄 Get started here","slug":"get-started-here"}],"owner":"29729601","collectionId":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","publishedId":"2sA3XY7deX","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"FF6C37"},"publishDate":"2024-06-25T06:01:32.000Z"},"item":[{"name":"Authentication","item":[{"name":"ForgetPassword","id":"dc6f3eef-457a-47e4-aca5-068327a682c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"email\":\"thapanaresh760@gmail.com\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{URL}}api/v1/user/forgot-password","description":"

This API endpoint is used to initiate the process of resetting a user's forgotten password.

Request Body

The request should be made using an HTTP POST method with a JSON payload in the request body. The payload should include the user's email address in the following format:

{\n    \"email\": \"user@example.com\"\n}\n\n

Response

Upon successful initiation of the password reset process, the API will return a response indicating the success of the request. The specific structure of the response will depend on the implementation of the API and the success status of the request.

PATCH /api/v1/user/reset-password/{resetToken}

This endpoint is used to reset the password for a user by providing a reset token.

Request Body

password (string, required): The new password for the user.
\n
passwordConfirm (string, required): Confirmation of the new password.
\n

Response

The response for this request is a JSON object with the following properties:

message (string): A message indicating the status of the password reset process.

{\n    \"message\": \"Password reset successful\"\n}\n\n

Delete Chat

This endpoint is used to delete a chat based on the provided chat ID.

Request Body

chatId (string, required): The ID of the chat to be deleted.

Response

The response will indicate the success or failure of the deletion operation.

\n","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","name":"MessageBuzz API","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"72481893-320b-4b76-8382-f68e28cc025f"},{"name":"save-chat","id":"8d28b7be-8c81-443b-9291-2a5e3abd490d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","name":"MessageBuzz API","type":"collection"}},"urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"8d28b7be-8c81-443b-9291-2a5e3abd490d"}],"id":"546a531d-4cbe-4861-bfd8-99408714cfe8","_postman_id":"546a531d-4cbe-4861-bfd8-99408714cfe8","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","name":"MessageBuzz API","type":"collection"}}},{"name":"User","item":[{"name":"createUser","event":[{"listen":"prerequest","script":{"id":"4734f70c-b63c-4565-aff2-a5f0f6def985","exec":[""],"type":"text/javascript","packages":{}}},{"listen":"test","script":{"id":"45b7933d-c726-4907-bcf9-886abfb22b72","exec":["pm.environment.set(\"jwt\", pm.response.json().token);"],"type":"text/javascript","packages":{}}}],"id":"39c1289a-a203-41c8-bc2b-94ca1b1ca12c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"noauth","isInherited":false},"method":"POST","header":[],"body":{"mode":"formdata","formdata":[{"key":"name","value":"naresh","type":"text"},{"key":"email","value":"thapanaresh42@gmail.com","type":"text"},{"key":"password","value":"hello123","type":"text"},{"key":"image","type":"file","fileNotInWorkingDirectoryWarning":"This file isn't in your working directory. Teammates you share this request with won't be able to use this file. To make collaboration easier you can setup your working directory in Settings.","filesNotInWorkingDirectory":["/C:/Users/thapa/Downloads/Snapchat for Web 2024-5-3 at 9_28_57 PM.jpeg"],"src":"/C:/Users/thapa/Downloads/Snapchat for Web 2024-5-3 at 9_28_57 PM.jpeg"}]},"url":"{{URL}}api/v1/user/signup","description":"\n

This endpoint is used to create a new user account.

Request Body

name (text): The name of the user.
\n
email (text): The email address of the user.
\n
password (text): The password for the user account.
\n
image (file): An optional image for the user profile.
\n

Response

The response of this request is a JSON schema representing the user account details.

\n","urlObject":{"path":["v1","user","signup"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"39c1289a-a203-41c8-bc2b-94ca1b1ca12c"},{"name":"UpdateUser","id":"c1c0aba9-d2e4-4d41-b536-2ded45796c28","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Update User Password

This endpoint allows the user to update their password.

Request Body

passwordCurrent (string, required): The user's current password.
\n
password (string, required): The new password.
\n
passwordConfirm (string, required): Confirmation of the new password.
\n

Response

The response for this request is a JSON object conforming to the following schema:

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"message\": {\n      \"type\": \"string\"\n    }\n  }\n}\n\n

Add Friend to User

This endpoint is used to add a friend to a user.

Request

Method: PATCH
\n
URL: {{URL}}api/v1/user/addFriend
\n
Body:
\n
- friendId (string, required): The ID of the friend to be added.
\n

Response

The response of this request is in JSON format and follows the schema below:

{\n  \"type\": \"object\",\n  \"properties\": {\n    // Define the properties of the response here\n  }\n}\n\n

This endpoint allows users to log in by providing their email and password.

Request Body

email (string, required): The email address of the user.
\n
password (string, required): The password for the user account.
\n

Response

The response will include the user's authentication token and other relevant user information upon successful login.

\n","urlObject":{"path":["v1","user","login"],"host":["{{URL}}api"],"query":[],"variable":[]}},"response":[],"_postman_id":"5c0fa738-fc22-4e73-9e7d-24d63161e300"}],"id":"de59def8-8cd9-4c86-9157-29feafa816ed","_postman_id":"de59def8-8cd9-4c86-9157-29feafa816ed","description":"","auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]},"isInherited":true,"source":{"_postman_id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","id":"a4e6322c-6c42-4f1a-99a1-ea20d9ae8e1d","name":"MessageBuzz API","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"basicConfig":[{"key":"key","value":"X-API-Key"},{"key":"value","value":"{{token}}"}]}},"event":[{"listen":"prerequest","script":{"type":"text/javascript","exec":[""]}},{"listen":"test","script":{"type":"text/javascript","exec":[""]}}],"variable":[{"id":"ee7eea7e-5492-47da-b8c5-0190d07fa8c8","key":"baseUrl","value":"https://farming-simulator.pstmn.io"}]}

📄 Get started here

🔖 How to use this template

Getting started guide

Authentication

Authentication error response

Rate and usage limits

503 response

Need some help?

Request Body

Response

PATCH /api/v1/user/reset-password/{resetToken}

Request Body

Response

Delete Chat

Request Body

Response

User Signup

Request Body

Response

Update User Password

Request Body

Response

Add Friend to User

Request

Response

User Login

Request Body

Response