UNPKG

watapi

Version:

API for WhatsApp using Baileys

173 lines (125 loc) 2.91 kB
# watAPI watAPI é uma API RESTful desenvolvida para facilitar a integração, consulta e manipulação de dados de maneira eficiente e segura. ## Sumário - [Instalação](#instalação) - [Configuração](#configuração) - [Rotas da API](#rotas-da-api) - [Exemplos de Uso](#exemplos-de-uso) - [Contribuição](#contribuição) - [Licença](#licença) ## Instalação Clone o repositório e instale as dependências: ```bash git clone https://github.com/seuusuario/watApi.git cd watApi npm install ``` ## Configuração Crie um arquivo `.env` na raiz do projeto com as variáveis de ambiente necessárias: ```env PORT=3000 DATABASE_URL=seu_banco_de_dados ``` ## Rotas da API ### Listar Mensagens **GET** `/api/messages` Retorna todas as mensagens cadastradas. **Exemplo de resposta:** ```json [ { "id": "abc123", "from": "5511999999999@c.us", "to": "5511888888888@c.us", "body": "Olá, tudo bem?", "timestamp": "2024-06-01T12:00:00.000Z" } ] ``` ### Enviar Mensagem **POST** `/api/messages/send` Envia uma nova mensagem via WhatsApp. **Body esperado:** ```json { "to": "5511888888888@c.us", "body": "Mensagem de teste" } ``` **Exemplo de resposta:** ```json { "status": "success", "messageId": "abc123" } ``` ### Buscar Mensagem por ID **GET** `/api/messages/{id}` Retorna uma mensagem específica pelo ID. **Exemplo de resposta:** ```json { "id": "abc123", "from": "5511999999999@c.us", "to": "5511888888888@c.us", "body": "Olá, tudo bem?", "timestamp": "2024-06-01T12:00:00.000Z" } ``` ### Atualizar Mensagem **PUT** `/api/messages/{id}` Atualiza o conteúdo de uma mensagem existente. **Body esperado:** ```json { "body": "Mensagem atualizada" } ``` **Exemplo de resposta:** ```json { "id": "abc123", "from": "5511999999999@c.us", "to": "5511888888888@c.us", "body": "Mensagem atualizada", "timestamp": "2024-06-01T12:00:00.000Z" } ``` ### Remover Mensagem **DELETE** `/api/messages/{id}` Remove uma mensagem pelo ID. **Exemplo de resposta:** ```json { "message": "Mensagem removida com sucesso" } ``` ## Exemplos de Uso ### Listar mensagens ```bash curl -X GET http://localhost:3000/api/messages ``` ### Enviar mensagem ```bash curl -X POST http://localhost:3000/api/messages/send \ -H "Content-Type: application/json" \ -d '{"to": "5511888888888@c.us", "body": "Mensagem de teste"}' ``` ### Buscar mensagem por ID ```bash curl -X GET http://localhost:3000/api/messages/abc123 ``` ### Atualizar mensagem ```bash curl -X PUT http://localhost:3000/api/messages/abc123 \ -H "Content-Type: application/json" \ -d '{"body": "Mensagem atualizada"}' ``` ### Remover mensagem ```bash curl -X DELETE http://localhost:3000/api/messages/abc123 ``` ## Contribuição Contribuições são bem-vindas! Abra uma issue ou envie um pull request. ## Licença Este projeto está licenciado sob a licença MIT.