Skip to content

Commit

Permalink
added postman collection and readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
ookamiiixd committed Jan 2, 2022
1 parent b8fe206 commit 6f649bb
Show file tree
Hide file tree
Showing 2 changed files with 1,411 additions and 0 deletions.
32 changes: 32 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Baileys API

An implementation of [@adiwajshing/Baileys](https://github.com/adiwajshing/Baileys) as a simple RESTful API service with multiple device support.

## Installation

1. Download or clone this repo.
2. Enter to the project directory.
3. Execute `npm i` to install the dependencies.

## Usage

1. You can start the app by executing `npm run start` or `node .`.
2. Now the endpoint should be available according to your environment variable settings. Default is at `http://localhost:8000`.

## API Docs

The API documentation is available online at [here](https://documenter.getpostman.com/view/18988925/UVRHiNne). You can also import the **Postman Collection File** `(postman_collection.json)` into your Postman App alternatively.

The server will respond in JSON format:

```javascript
{
success: true|false, // bool
message: "", // string
data: {} // object
}
```

## Notice

This project is intended for learning purpose only, don't use this for spam or any activities that is prohibited by **WhatsApp**.
Loading

0 comments on commit 6f649bb

Please sign in to comment.