← Documentação·Outro

Complemento API mewayz

●  Atualizado em maio de 2026Mewayz

API Mewayz Complemento

Descubra o poder da integração API do Mewayz para gerenciamento perfeito de projetos e tarefas. Amplie e personalize com facilidade. Experimente agora!

URL de demonstração

Introdução

O API Docs Generator é um complemento poderoso que fornece documentação API completa para a plataforma Mewayz. Este complemento ajuda desenvolvedores e equipes técnicas a acessar informações detalhadas da API, incluindo endpoints, cabeçalhos, parâmetros e exemplos de resposta. A documentação cobre 14 módulos principais da plataforma e permite que os usuários criem aplicativos personalizados, integrem sistemas externos ou testem APIs manualmente usando ferramentas como o Postman.

Como habilitar este módulo

Para configurar o complemento da API, você pode seguir este link: Complemento de configuração.

Como usar o complemento API?

Gerar documentos de API

Depois de comprar e instalar este complemento, vá para a barra lateral do painel e pesquise o complemento API Docs.

Para acessar a documentação da API, navegue até a seção Api Docs em seu painel principal. A documentação é organizada por 14 módulos, facilitando a localização das APIs específicas necessárias para seu projeto de integração.

A seção inclui uma introdução geral que explica como usar as APIs de maneira eficaz. Esta visão geral abrange requisitos de autenticação, cabeçalhos comuns e diretrizes básicas de uso que se aplicam a todos os endpoints da API.

Cada módulo contém listagens de API poderosas com detalhes técnicos completos. Para cada endpoint da API, você encontrará o nome da API, URL exato do endpoint, cabeçalhos necessários para autenticação e formato de dados, parâmetros de entrada com seus tipos de dados e regras de validação, exemplos de respostas de sucesso mostrando a estrutura de dados esperada e exemplos de respostas de erro com códigos de erro e mensagens comuns.

Gerenciamento de introdução

Esta documentação abrangente da API é a sua porta de entrada para aproveitar o poder dos recursos do Mewayz, permitindo agilizar seu trabalho, aumentar a produtividade e levar seus projetos para o próximo nível.

Esta documentação da API é um recurso para desenvolvedores, tanto experientes quanto novos, que desejam aproveitar os recursos do Mewayz em seus aplicativos. Aqui está o que você pode esperar encontrar.

Você pode navegar pela referência completa e interativa dentro do produto em Configurações → Documentos API.

A seção de endpoints cobre GET para recuperar dados, POST para criar novos dados, POST para atualizar dados existentes e DELETE para remover dados. Você pode usar métodos HTTP como GET para recuperar dados, POST para criar novos dados, POST para atualizar dados existentes e DELETE para remover dados.

Os parâmetros de solicitação são usados ​​para personalizar o comportamento de suas solicitações de API e fornecer detalhes mais específicos ao interagir com a API. Para Mewayz, você pode ter os seguintes tipos de parâmetros de solicitação: Parâmetros de consulta para filtrar ou classificar dados ao recuperar informações, Cabeçalhos de solicitação para autenticação e metadados adicionais sobre a solicitação e Corpo da solicitação contendo dados JSON a serem criados ou atualizados.

A API de Mewayz normalmente responde com dados no formato JSON. A resposta normalmente inclui um código de status HTTP indicando o resultado da solicitação, e os dados reais estão contidos no “dados” campo.

Gerenciamento de autenticação

As APIs de autenticação fornecem a funcionalidade essencial de login, recursos de atualização de token para manutenção de sessões e procedimentos de logout para sessões de usuário finais com segurança.

O endpoint de login POST /api/login requer cabeçalhos com “Aceitar”: “aplicativo/json” e parâmetros incluindo e-mail como “[email protected]” e senha como **“john****”**.

As respostas de erro retornam 422 Conteúdo não processável com “sucesso”: falso, “mensagem”: “Validação Quando a validação é um erro.

As respostas de erro retornam 400 Não autorizado com “sucesso”: falso, “mensagem”: “O fornecido” quando as credenciais são inválidas.

As respostas de login bem-sucedidas retornam 200 OK com “sucesso”: verdadeiro e autorização contendo token e tipo “portador” para chamadas de API subsequentes.

O endpoint de atualização de autenticação POST /api/refresh usa cabeçalhos de autorização com um token de portador para gerenciamento de sessão.

As respostas de atualização bem-sucedidas retornam informações detalhadas do usuário, incluindo 200 OK com “sucesso”: verdadeiro e detalhes do usuário, id, nome, email, mobile_no, digite: “empresa”, avatar: “URL”, idioma: “pt” e ficha.

Gerenciamento de usuários

Gestão de Armazéns

Gestão de Produtos e Serviços

Gerenciamento de fatura de compra

Gerenciamento de devolução de compras

Gerenciamento de propostas de vendas

Gerenciamento de faturas de vendas

Gerenciamento de devolução de faturas de vendas

Gerenciamento de contas

Gerenciamento de Projetos

Gestão de PDV

Gestão de CRM

Gestão de RH

Cada endpoint de API na documentação inclui exemplos práticos que você pode copiar e usar diretamente em seu ambiente de desenvolvimento ou ferramentas de teste. Os exemplos de resposta mostram operações bem-sucedidas e cenários de erros comuns, ajudando você a implementar o tratamento adequado de erros em seus aplicativos.

Lista de APIs inteligentes de módulos:

Isso foi útil?
← Todos os documentosPergunte à equipeExperimente gratuitamente →