Documentos API · Mewayz

Autenticação

Cada solicitação é autenticada com um token de portador. Gere um em seu painel em Configurações → Chaves API - é mostrado uma vez, então copie-o. Um token herda as funções e permissões do usuário que o criou, e a maioria dos endpoints de recursos também exige que o módulo correspondente seja habilitado em seu plano.

Cabeçalho de autorização

# Passe seu token em cada solicitação enrolar https://app.mewayz.com/api/leads \ -H "Autorização: Portador 12|aZ8f3a...d92c" \ -H "Aceitar: aplicativo/json"

Prefere autenticar programaticamente? POST /api/login com seu e-mail e senha retorna um token ao portador que você pode usar da mesma maneira, e POST /api/atualizar gira.

Início rápido

Crie um lead de CRM em menos de um minuto. A API funciona com os mesmos dados que você vê no produto – não há uma camada de sincronização separada.

POST /api/lead/criar

enrolar -X POSTAR https://app.mewayz.com/api/lead/create \ -H "Autorização: Portador 12|aZ8f3a..." \ -H "Tipo de conteúdo: aplicativo/json" \ -H "Aceitar: aplicativo/json" \ -d '{ "nome": "Ada Lovelace", "e-mail": "[email protected]" }'

Erros e códigos de status

Usamos códigos de status HTTP convencionais. Os corpos de erro incluem um formato legível por humanos mensagem você pode emergir diretamente.

200	OK – solicitação bem-sucedida
201	Criado — recurso criado
401	Não autorizado – token ausente ou inválido
422	Não processável – falha na validação
429	Muitas solicitações – você atingiu um limite de taxa
500	Erro no servidor – vamos ativá-lo estado

Limites de taxa

O tráfego da API tem taxa limitada para manter a plataforma rápida para todos. Se você exceder o limite, receberá um HTTP 429 resposta – recue e tente novamente. O Tentar novamente depois header informa quando você pode retomar.

Autenticação e sessão /api/login

Faça login, atualize ou revogue seu token, busque o usuário conectado, edite o perfil e leia as listas de usuários da equipe/cliente/fornecedor. (11 pontos finais)

POSTAR	/api/alterar senha
OBTER	/api/cliente-usuário
EXCLUIR	/api/delete-conta
POSTAR	/api/editar perfil
POSTAR	/api/login
POSTAR	/api/logout
POSTAR	/api/atualizar
OBTER	/api/usuário-equipe
POSTAR	/api/upload-fotos
OBTER	/api/usuário
OBTER	/api/usuário-fornecedor

Chaves de API /api/v1/settings/api-keys

Liste, crie e revogue seus tokens de acesso pessoal — as mesmas chaves que você gera em Configurações → Chaves de API. (3 pontos finais)

OBTER	/api/v1/settings/api-keys
POSTAR	/api/v1/settings/api-keys
EXCLUIR	/api/v1/settings/api-keys/{id}

CRM – leads, negócios e pipeline /api/leads

CRUD completo sobre leads, negócios, pipelines, estágios, rótulos e fontes, além de suas tarefas, chamadas, arquivos, notas e produtos. (79 pontos finais)

EXCLUIR	/api/deal-call/delete/{call_id}
POSTAR	/api/deal-call/loja
POSTAR	/api/deal-call/update/{call_id}
POSTAR	/api/deal-client/store/{deal_id}
EXCLUIR	/api/deal-client/{deal_id}/delete/{client_id}
POSTAR	/api/deal-discussion/store/{deal_id}
POSTAR	/api/deal-email/store/{deal_id}
POSTAR	/api/deal-file/store/{deal_id}
EXCLUIR	/api/deal-file/{deal_id}/delete/{file_id}
POSTAR	/api/deal-source/store/{deal_id}
EXCLUIR	/api/deal-source/{deal_id}/delete/{source_id}
POSTAR	/api/deal-stage/criar
EXCLUIR	/api/deal-stage/delete/{id}
POSTAR	/api/deal-stage/update/{id}
OBTER	/api/estágios do negócio
POSTAR	/api/deal-task/criar
EXCLUIR	/api/deal-task/delete/{id}
POSTAR	/api/deal-task/update/{id}
POSTAR	/api/deal-user/store/{deal_id}
EXCLUIR	/api/deal-user/{deal_id}/delete/{user_id}
POSTAR	/api/deal/add-label/{id}
POSTAR	/api/deal/assign-products/{deal_id}
POSTAR	/api/deal/criar
EXCLUIR	/api/deal/delete/{id}
OBTER	/api/deal/show/{id}
POSTAR	/api/deal/update/{id}
EXCLUIR	/api/deal/{deal_id}/produtos/{product_id}
OBTER	/api/ofertas
POSTAR	/api/rótulo/criar
EXCLUIR	/api/label/delete/{id}
POSTAR	/api/label/update/{id}
OBTER	/api/rótulos
EXCLUIR	/api/lead-call/delete/{call_id}
POSTAR	/api/lead-call/loja
POSTAR	/api/lead-call/update/{call_id}
POSTAR	/api/lead-discussion/store/{lead_id}
POSTAR	/api/lead-email/store/{lead_id}
POSTAR	/api/lead-file/store/{lead_id}
EXCLUIR	/api/lead-file/{lead_id}/delete/{file_id}
POSTAR	/api/lead-source/store/{lead_id}
EXCLUIR	/api/lead-source/{lead_id}/delete/{source_id}
POSTAR	/api/estágio principal/criar
EXCLUIR	/api/lead-stage/delete/{id}
POSTAR	/api/lead-stage/update/{id}
OBTER	/api/estágios-lead
POSTAR	/api/lead-task/criar
EXCLUIR	/api/lead-task/delete/{id}
POSTAR	/api/lead-task/update/{id}
POSTAR	/api/lead-user/store/{lead_id}
EXCLUIR	/api/lead-user/{lead_id}/delete/{user_id}
POSTAR	/api/lead/add-label/{id}
POSTAR	/api/lead/assign-produtos/{lead_id}
POSTAR	/api/lead/convert-to-deal/{id}
POSTAR	/api/lead/criar
EXCLUIR	/api/lead/delete/{id}
OBTER	/api/lead/get-request-data
OBTER	/api/lead/get-users
POSTAR	/api/lead/home
POSTAR	/api/lead/lead-create-update
POSTAR	/api/lead/lead-delete
POSTAR	/api/lead/lead-details
POSTAR	/api/lead/lead-stage-create-update
POSTAR	/api/lead/lead-stage-update
POSTAR	/api/lead/lead-stages
POSTAR	/api/lead/leadboard
POSTAR	/api/lead/pipeline-create-update
OBTER	/api/lead/pipelines
OBTER	/api/lead/show/{id}
POSTAR	/api/lead/update/{id}
EXCLUIR	/api/lead/{lead_id}/produtos/{product_id}
OBTER	/api/leads
POSTAR	/api/pipeline/criar
EXCLUIR	/api/pipeline/delete/{id}
POSTAR	/api/pipeline/atualização/{id}
OBTER	/api/pipelines
POSTAR	/api/fonte/criar
EXCLUIR	/api/source/delete/{id}
POSTAR	/api/source/update/{id}
OBTER	/api/fontes

Vendas /api/vendas/pedidos de vendas

Oportunidades, cotações, reuniões, pedidos de vendas e pesquisas de armazém. (23 pontos finais)

OBTER	/api/vendas/RequestData
POSTAR	/api/vendas/get-warehouse-products
OBTER	/api/vendas/home
EXCLUIR	/api/vendas/reunião/destruir/{id}
POSTAR	/api/vendas/reunião/loja
POSTAR	/api/vendas/reunião/atualização/{id}
OBTER	/api/vendas/reuniões
OBTER	/api/vendas/oportunidades
EXCLUIR	/api/vendas/oportunidades/delete/{id}
POSTAR	/api/vendas/oportunidades/atualização/{id}
POSTAR	/api/vendas/oportunidade/loja
POSTAR	/api/vendas/registros-pai
OBTER	/api/vendas/cotações
EXCLUIR	/api/vendas/cotações/destruir/{id}
POSTAR	/api/vendas/cotações/loja
POSTAR	/api/vendas/cotações/atualização/{id}
OBTER	/api/vendas/cotações/{id}
EXCLUIR	/api/vendas/pedido de venda/delete/{id}
POSTAR	/api/vendas/pedido de venda/loja
POSTAR	/api/vendas/pedido de venda/atualização/{id}
OBTER	/api/vendas/pedidos de vendas
OBTER	/api/vendas/pedidos-de-venda/{id}
OBTER	/api/vendas/armazéns

Propostas de vendas /api/proposta de vendas

Elabore, envie, aceite/rejeite propostas e converta-as em faturas. (9 pontos finais)

OBTER	/api/proposta de vendas
POSTAR	/api/proposta-de-venda/accept/{proposal_id}
POSTAR	/api/proposta-de-venda/convert-to-invoice/{proposal_id}
POSTAR	/api/proposta de vendas/criar
EXCLUIR	/api/proposta-de-venda/delete/{proposal_id}
POSTAR	/api/proposta-de-venda/rejeitar/{proposal_id}
POSTAR	/api/proposta-de-venda/enviada/{proposal_id}
OBTER	/api/proposta-de-venda/show/{proposal_id}
POSTAR	/api/proposta-de-venda/atualização/{proposal_id}

Faturas de vendas /api/fatura de vendas

Liste, crie, atualize, exclua e lance faturas de vendas. (6 pontos finais)

OBTER	/api/fatura de vendas
POSTAR	/api/fatura de vendas/criar
EXCLUIR	/api/fatura de vendas/delete/{id_da_fatura}
POSTAR	/api/fatura de vendas/post/{id da fatura}
OBTER	/api/fatura de vendas/show/{id da fatura}
POSTAR	/api/fatura de vendas/atualização/{id da fatura}

Devoluções de faturas de vendas /api/fatura-de-venda-retorno

Crie, aprove e preencha devoluções de faturas de vendas. (6 pontos finais)

OBTER	/api/fatura-de-venda-retorno
POSTAR	/api/fatura de vendas-return/approve/{return_id}
POSTAR	/api/fatura-de-venda-return/complete/{return_id}
POSTAR	/api/fatura-de-venda-retorno/criar
EXCLUIR	/api/fatura-de-venda-return/delete/{return_id}
OBTER	/api/fatura-de-venda-return/show/{return_id}

Faturas de compra /api/fatura de compra

Liste, crie, atualize, exclua e lance faturas de compra. (6 pontos finais)

OBTER	/api/fatura de compra
POSTAR	/api/fatura de compra/criar
EXCLUIR	/api/fatura-de-compra/delete/{id_da_fatura}
POSTAR	/api/fatura-compra/post/{id_fatura}
OBTER	/api/purchase-invoice/show/{invoice_id}
POSTAR	/api/fatura de compra/atualização/{id da fatura}

Devoluções de compra /api/retorno de compra

Crie, aprove e conclua devoluções de compras. (6 pontos finais)

OBTER	/api/retorno de compra
POSTAR	/api/purchase-return/approve/{return_id}
POSTAR	/api/purchase-return/complete/{return_id}
POSTAR	/api/compra-retorno/criar
EXCLUIR	/api/purchase-return/delete/{return_id}
OBTER	/api/purchase-return/show/{return_id}

Contabilidade /api/plano de contas

Clientes, fornecedores, contas bancárias, plano de contas, receitas, despesas, pagamentos, notas de crédito/débito e transferências. (37 pontos finais)

OBTER	/api/tipos de conta
OBTER	/api/contas bancárias
POSTAR	/api/contas bancárias/criar
EXCLUIR	/api/contas bancárias/delete/{id}
POSTAR	/api/contas bancárias/update/{id}
OBTER	/api/transações bancárias
OBTER	/api/transferências bancárias
OBTER	/api/plano de contas
OBTER	/api/notas de crédito
OBTER	/api/pagamentos do cliente
OBTER	/api/clientes
POSTAR	/api/clientes/criar
EXCLUIR	/api/clientes/delete/{id}
POSTAR	/api/clientes/atualização/{id}
OBTER	/api/notas de débito
OBTER	/api/categorias de despesas
OBTER	/api/despesas
POSTAR	/api/despesas/aprovar/{id}
POSTAR	/api/despesas/criar
EXCLUIR	/api/despesas/delete/{id}
POSTAR	/api/despesas/post/{id}
POSTAR	/api/despesas/atualização/{id}
OBTER	/api/get-clientes
OBTER	/api/get-vendors
OBTER	/api/gl-contas
OBTER	/api/categorias de receita
OBTER	/api/receitas
POSTAR	/api/receitas/aprovar/{id}
POSTAR	/api/receitas/criar
EXCLUIR	/api/receitas/delete/{id}
POSTAR	/api/receitas/post/{id}
POSTAR	/api/receitas/atualização/{id}
OBTER	/api/pagamentos de fornecedores
OBTER	/api/vendedores
POSTAR	/api/vendors/criar
EXCLUIR	/api/vendors/delete/{id}
POSTAR	/api/vendors/update/{id}

Produtos e serviços /api/produtos

Produtos, categorias, impostos, unidades e estoque. (20 pontos finais)

OBTER	/api/produto-serviço/itens
POSTAR	/api/estoque de produto/adicionar
OBTER	/api/estoques de produtos
OBTER	/api/produto/categoria
POSTAR	/api/produto/categoria/criar
EXCLUIR	/api/produto/categoria/delete/{id}
POSTAR	/api/produto/categoria/atualização/{id}
POSTAR	/api/produto/criar
EXCLUIR	/api/produto/delete/{id}
OBTER	/api/produto/detalhe/{id}
POSTAR	/api/produto/atualização/{id}
OBTER	/api/produtos
OBTER	/api/imposto
POSTAR	/api/imposto/criar
EXCLUIR	/api/imposto/delete/{id}
POSTAR	/api/imposto/atualização/{id}
POSTAR	/api/unidade/criar
EXCLUIR	/api/unidade/delete/{id}
POSTAR	/api/unidade/atualização/{id}
OBTER	/api/unidades

Armazém e inventário /api/armazém

Armazéns e transferências de stock. (9 pontos finais)

OBTER	/api/transferência
POSTAR	/api/transferir/criar
EXCLUIR	/api/transfer/delete/{transfer_id}
OBTER	/api/transferência/request-data
OBTER	/api/armazém
POSTAR	/api/warehouse/criar
EXCLUIR	/api/warehouse/delete/{warehouse_id}
OBTER	/api/warehouse/product/{warehouse_id}
POSTAR	/api/warehouse/update/{warehouse_id}

Projetos, tarefas e bugs /api/projetos

Projetos, marcos, quadros de tarefas, tarefas, subtarefas, bugs e relatórios. (45 pontos finais)

OBTER	/api/lista de status de bug
OBTER	/api/get-projects
POSTAR	/api/projeto/bug-stage/create
EXCLUIR	/api/projeto/bug-stage/delete/{id}
POSTAR	/api/projeto/estágio de bug/pedido
POSTAR	/api/projeto/bug-stage/update/{id}
OBTER	/api/projeto/estágios de bug
POSTAR	/api/projeto/bug/create/{project_id}
OBTER	/api/projeto/bug/show/{bug_id}
POSTAR	/api/project/bug/{bug_id}/comment/create
EXCLUIR	/api/project/bug/{id}/comment/delete
OBTER	/api/projeto/bug/{project_id}
EXCLUIR	/api/projeto/cliente/delete/{id}
POSTAR	/api/projeto/cliente/convite
OBTER	/api/projeto/clientes
EXCLUIR	/api/projeto/delete/{id}
POSTAR	/api/projeto/arquivo/criar
EXCLUIR	/api/projeto/arquivo/delete/{id}
EXCLUIR	/api/projeto/membro/delete/{id}
POSTAR	/api/projeto/marco/criar
EXCLUIR	/api/projeto/marco/delete/{id}
POSTAR	/api/projeto/milestone/update/{id}
OBTER	/api/projeto/marcos
OBTER	/api/projeto/relatório/{id}
OBTER	/api/projeto/relatórios
OBTER	/api/projeto/show/{id}
POSTAR	/api/projeto/estágio de tarefa/criar
EXCLUIR	/api/project/task-stage/delete/{id}
POSTAR	/api/projeto/estágio de tarefa/pedido
POSTAR	/api/project/task-stage/update/{id}
OBTER	/api/projeto/estágios de tarefas
POSTAR	/api/project/task-subtask/create/{task_id}
POSTAR	/api/project/task-subtask/update/{subtask_id}
EXCLUIR	/api/projeto/tarefa/comment/delete/{comment_id}
OBTER	/api/projeto/tarefa/show/{id}
POSTAR	/api/project/task/{task_id}/comment/create
POSTAR	/api/projeto/atualização/{id}
OBTER	/api/projeto/{id}/quadro de tarefas
POSTAR	/api/projeto/{id}/tarefa/criar
POSTAR	/api/projeto/{id}/task/update/{task_id}
EXCLUIR	/api/projeto/{project_id}/bug/delete/{bug_id}
POSTAR	/api/projeto/{project_id}/bug/update/{bug_id}
EXCLUIR	/api/project/{project_id}/task/delete/{task_id}
OBTER	/api/projetos
POSTAR	/api/projetos/criar

Ponto de venda /api/pos

Pedidos POS e detalhes do pedido. (2 pontos finais)

OBTER	/api/pos
OBTER	/api/pos/show/{id}

Balcão de suporte /api/support-ticket/tickets

Tickets e respostas, perguntas frequentes e artigos da base de conhecimento. (16 pontos finais)

POSTAR	/api/support-ticket/faq/delete/{faq_id}
POSTAR	/api/support-ticket/faq/update/{faq_id}
OBTER	/api/support-ticket/faqs
POSTAR	/api/support-ticket/faqs/loja
OBTER	/api/support-ticket/get-request-data
OBTER	/api/support-ticket/home
POSTAR	/api/support-ticket/knowledge/delete/{knowledge_id}
POSTAR	/api/support-ticket/conhecimento/loja
POSTAR	/api/support-ticket/knowledge/update/{knowledge_id}
OBTER	/api/support-ticket/conhecimentos
POSTAR	/api/support-ticket/ticket/add-reply/{ticket_id}
POSTAR	/api/support-ticket/ticket/delete/{ticket_id}
POSTAR	/api/support-ticket/ticket/note/store/{ticket_id}
POSTAR	/api/support-ticket/ticket/loja
POSTAR	/api/support-ticket/ticket/update/{ticket_id}
OBTER	/api/support-ticket/tickets

Tarefa /api/taskly/projetos

Projetos de tarefas e tarefas para o módulo de projeto leve. (18 pontos finais)

OBTER	/api/taskly/home
POSTAR	/api/taskly/atividade do projeto
POSTAR	/api/taskly/project-create-update
POSTAR	/api/taskly/project-delete
POSTAR	/api/taskly/detalhes do projeto
EXCLUIR	/api/taskly/project-file-delete/{id}
POSTAR	/api/taskly/upload de arquivo de projeto
POSTAR	/api/taskly/lista de projetos
POSTAR	/api/taskly/project-status-update
OBTER	/api/taskly/projetos
OBTER	/api/taskly/projects/{projeto}/tarefas
POSTAR	/api/taskly/task-create-update
POSTAR	/api/taskly/task-delete
POSTAR	/api/taskly/detalhes da tarefa
POSTAR	/api/taskly/lista de tarefas
POSTAR	/api/taskly/task-stage-update
POSTAR	/api/taskly/quadro de tarefas
OBTER	/api/taskly/usuários

Controle de tempo /api/adicionar-tracker

Inicie e pare rastreadores de tempo. (3 pontos finais)

POSTAR	/api/adicionar-tracker
POSTAR	/api/stop-tracker
POSTAR	/api/tracker-login

Usuários e funções /api/usuários

Administre usuários do espaço de trabalho e leia funções. (8 pontos finais)

OBTER	/api/funções
EXCLUIR	/api/usuário/delete/{id}
POSTAR	/api/usuário/reset-senha/{id}
POSTAR	/api/usuário/loja
POSTAR	/api/usuário/atualização/{id}
COLOCAR	/api/usuário/verificar/{id}
OBTER	/api/usuários
OBTER	/api/usuários/log

RH e folha de pagamento /api/funcionários

Funcionários, frequência, licenças, folha de pagamento, além do conjunto completo de registros de RH (filiais, departamentos, feriados, prêmios e muito mais). (44 pontos finais)

OBTER	/api/agradecimentos
OBTER	/api/anúncios
POSTAR	/api/atendimento/criar
EXCLUIR	/api/atendimento/delete/{attendance_id}
POSTAR	/api/atendimento/atualização/{attendance_id}
OBTER	/api/atendimentos
OBTER	/api/prêmios
OBTER	/api/braços
OBTER	/api/reclamações
OBTER	/api/departamentos
OBTER	/api/designações
OBTER	/api/tipos de documentos
OBTER	/api/transferências de funcionários
POSTAR	/api/funcionário/criar
EXCLUIR	/api/funcionário/delete/{id}
OBTER	/api/funcionário/show/{id}
POSTAR	/api/funcionário/atualização/{id}
OBTER	/api/funcionários
OBTER	/api/eventos
OBTER	/api/feriados
OBTER	/api/hrm-documentos
POSTAR	/api/hrm/histórico de atendimento
POSTAR	/api/hrm/relógio de entrada
POSTAR	/api/hrm/eventos
OBTER	/api/hrm/get-folhas
OBTER	/api/hrm/get-leaves-types
OBTER	/api/hrm/lista de feriados
OBTER	/api/hrm/home
POSTAR	/api/hrm/pedido de licença
POSTAR	/api/leave-application/criar
EXCLUIR	/api/leave-application/delete/{leaveapplication_id}
POSTAR	/api/leave-application/update-status/{leaveapplication_id}
POSTAR	/api/leave-application/update/{leaveapplication_id}
OBTER	/api/deixe-aplicativos
OBTER	/api/deixar saldos
OBTER	/api/tipos de licença
OBTER	/api/folhas de pagamento
OBTER	/api/folhas de pagamento/{payroll_id}
OBTER	/api/recibo de pagamento/{payroll_entry_id}
OBTER	/api/promoções
OBTER	/api/renúncias
OBTER	/api/shifts
OBTER	/api/terminações
OBTER	/api/avisos

API de terceiros (v1) /api/v1/clientes

Uma fatia estável e versionada desenvolvida para ferramentas sem código como Zapier — clientes e faturas. (7 pontos finais)

OBTER	/api/v1/clientes
POSTAR	/api/v1/clientes
OBTER	/api/v1/clientes/{id}
COLOCAR	/api/v1/clientes/{id}
OBTER	/api/v1/faturas
POSTAR	/api/v1/faturas
OBTER	/api/v1/faturas/{id}

Pontos de extremidade públicos /api/public/planos

Ajudantes não autenticados: o catálogo de planos públicos e o widget incorporável de captura de leads e o selo de parceiro. (4 pontos finais)

OBTER	/api/crachá/{token}
OBTER	/api/public/planos
POSTAR	/api/widget/lead
OBTER	/api/widget/{token}

Plataforma de marca branca /api/wl/planos

Endpoints de servidor para servidor usados por instâncias de marca branca para faturamento e Stripe Connect (autenticadas por token). (6 pontos finais)

POSTAR	/api/wl/checkout
POSTAR	/api/wl/conectar/integrar
OBTER	/api/wl/conectar/status
OBTER	/api/wl/planos
POSTAR	/api/wl/subscription/{stripe_subscription_id}/cancel
POSTAR	/api/wl/webhook-retorno de chamada

Pontos de extremidade de integração /api/microsofttodo

Endpoints auxiliares para integrações conectadas (Microsoft To Do, Vonage SMS, postagens no Facebook). (3 pontos finais)

OBTER	/api/facebookpost
OBTER	/api/microsofttodo
OBTER	/api/vonagesms

Mais pontos de extremidade

Pontos de extremidade registrados adicionais. (1 ponto final)

OBTER

/api/agentes/{agente}/comissões pendentes

ConstruirMewayz.