UNPKG

mdevcloud-api

Version:

SDK oficial para consumir a API MDev Cloud Registrations

221 lines (135 loc) 4.27 kB
## cmdevcloud-api SDK oficial para consumir a **API MDev Cloud Registrations**. Auxilia no **armazenamento e gerenciamento de bots** para **WhatsApp, Discord e Telegram**. ## ✨ Recursos - Criar, atualizar, buscar e deletar registros de bots - Cache centralizado dos clientes - Autenticação via **db_key** - Simples e rápido de integrar em qualquer projeto Node.js ## 📦 Instalação ```bash npm install mdevcloud-api ```` --- ## 🚀 Uso ```js const CloudClient = require("mdev-cloud-client"); // Inicializa o cliente informando o host da API e a db_key const client = new CloudClient("http://localhost:3000", "sua_db_key"); (async () => { // Criar novo bot const novo = await client.createClient({ jid: "jid-teste", username: "nickname" }); console.log("Criado:", novo); // Buscar bot específico const encontrado = await client.getClient("jid-teste"); console.log("Encontrado:", encontrado); // Atualizar bot const atualizado = await client.updateClient("jid-teste", { isPremium: true }); console.log("Atualizado:", atualizado); // Listar todos os bots const todos = await client.getAllClients(); console.log("Todos:", todos); // Deletar bot const deletado = await client.deleteClient("jid-teste"); console.log("Deletado:", deletado); })(); // Retorno de um registro { jid: number, name: string, jid: string, money: number, isPremium: boolean, isOwner: boolean, isBanned: boolean, createdAt: string, xp: number, databaseUserId: string } ``` --- ## 📚 API ### `new CloudClient(host, db_key)` Cria uma nova instância do cliente. * `host` *(string)* URL base da sua API (ex: `http://localhost:3000`) * `db_key` *(string)* chave de acesso única do seu banco --- ### `createClient({ jid, username })` Cria um novo registro de bot. * `jid` *(string)* identificador único do bot * `username` *(string, opcional)* nome do bot --- ### `getClient(jid)` Busca um bot específico. * `jid` *(string)* identificador do bot --- ### `getAllClients()` Retorna todos os bots associados ao `db_key`. --- ### `updateClient(jid, update)` Atualiza os dados de um bot. * `jid` *(string)* identificador do bot * `update` *(object)* campos a serem atualizados (ex: `{ isPremium: true }`) --- ### `deleteClient(jid)` Deleta um bot específico. * `jid` *(string)* identificador do bot --- ## 🛠️ Tecnologias * Node.js * Fetch API * Integração com **Next.js API Routes** --- ## 👨‍💻 Autor Feito com ❤️ por **MDevSystems** 📷 [@luciano\_mendez9](https://instagram.com/luciano_mendesz9) --- ## 📄 Licença Este projeto está sob a licença **MIT**. Sinta-se livre para usar e contribuir. ``` --- Quer que eu deixe esse README.md ainda com **badges bonitinhas** (npm version, downloads, license) no topo, estilo libs famosas? ``` ## 📚 API ### `new CloudClient(host, db_key)` Cria uma nova instância do cliente. * `host`*(string)* URL base da sua API (ex: `http://localhost:3000`) * `db_key`*(string)* chave de acesso única do seu banco --- ### `createClient({ jid, username })` Cria um novo registro de bot. * `jid`*(string)* identificador único do bot * `username`*(string, opcional)* nome do bot --- ### `getClient(jid)` Busca um bot específico. * `jid`*(string)* identificador do bot --- ### `getAllClients()` Retorna todos os bots associados ao `db_key`. --- ### `updateClient(jid, update)` Atualiza os dados de um bot. * `jid`*(string)* identificador do bot * `update`*(object)* campos a serem atualizados (ex: `{ isPremium: true }`) --- ### `deleteClient(jid)` Deleta um bot específico. * `jid`*(string)* identificador do bot --- ## 🛠️ Tecnologias * Node.js * Fetch API * Integração com **Next.js API Routes** --- ## 👨‍💻 Autor Feito com ❤️ por **MDevSystems** 📷 [@luciano\_mendez9](https://instagram.com/luciano_mendez9) --- ## 📄 Licença Este projeto está sob a licença **MIT**. Sinta-se livre para usar e contribuir.