Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/prathamesh017/chatbot-api

Last synced: 11 days ago
JSON representation

Host: GitHub
URL: https://github.com/prathamesh017/chatbot-api
Owner: Prathamesh017
Created: 2023-08-27T06:16:48.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-08-27T06:23:05.000Z (about 1 year ago)
Last Synced: 2023-08-27T07:33:19.320Z (about 1 year ago)
Language: JavaScript
Size: 36.1 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: readme.md

Awesome Lists containing this project

README

Chat-BOT API DOCUMENATION

Welcome to the Chat Bot API documentation. This API allows you to see products ,add and remove them from cart and place order

Installation Steps
```bash
npm install
npm run server
```

## Authentication
This API requires API key authentication. Include your API key in the Authorization header of your requests.

## ENDPOINTS
- USER

a) /api/users Creates a New User
Method - Post.
Request - { _
email, _
name, _
password _
}
Response - Token (Use this for authentication)

b) /api/users - list all users
Method - Get
Response - List All Users

c) /api/users/:id - list a users
Method - Get
Response - List A Users

d) /api/users/:id - updates a users
Method - Put
Authenicate - Requires Token
Response - Updates A Users

e) /api/users/:id - delete a users
Method - Delete
Authenicate - Requires Token
Response - Delete A Users

- ChatBot

a) /users/:userId/chatbots - Create A Chatbot for User
Method - Post
Authenicate - Requires User Token
Response - Created Chatbot

b) /users/:userId/chatbots - List all chatbots for a user
Method - Get
Response - Get all Chatbots

c) /chatbots/:chatbotId - Retrieve a single chatbot
Method - Get
Authenicate - Requires User Token
Response - Get a Chatbot

d) /chatbots/:chatbotId - Update a chatbot
Method - Put
Authenicate - Requires User Token
Response - Update a Chatbot

e) /chatbots/:chatbotId - delete a chatbot
Method - Delete
Authenicate - Requires User Token
Response - Delete a Chatbot

- Conversations

a) chatbots/:chatbotId/conversations Start a New Chat
Method - Post.
Request - { _
message _
complete:true/false, _
}
Authenicate - Requires End User Token
Response - chats

b) /chatbots/:chatbotId/conversations - List all conversations for a chatbot
Method - Get
Authenicate - Requires End User Token
Response - List All end Users

c) conversations/:conversationId - Retrive Single Communication
Method - Get
Authenicate - Requires End User Token
Response - Retrieve a single conversation

d) /conversations/:conversationId - Update a conversation
Method - Put
Authenicate - Requires End User Token
Response - Update a conversation

e) /conversations/:conversationId - End/delete a conversation
Method - Delete
Authenicate - Requires End User Token
Response - Delete A End Users

- END USERS

a) /api/endusers Creates a New End User
Method - Post.
Request - { _
email, _
name, _
}
Response - Token (Use this for authentication)

b) /api/endusers - list all end users
Method - Get
Authenicate - Requires User Token
Response - List All end Users

c) /api/endusers/:id - list a users
Method - Get
Authenicate - Requires User Token
Response - List A end Users

d) /api/endusers/:id - updates a users
Method - Put
Authenicate - Requires Token
Response - Updates A End Users

e) /api/endusers/:id - delete a users
Method - Delete
Authenicate - Requires Token
Response - Delete A Users