A API do Monde permite integrar o Monde com outros sistemas, sites ou ferramentas externas.
Com ela, é possível automatizar processos e evitar retrabalho, utilizando no Monde informações que já foram preenchidas em outros locais, como:
Site da agência;
Formulários externos;
Ferramentas de atendimento;
Sistemas internos;
Ferramentas de BI;
Outras plataformas utilizadas pela agência.
Na prática, a API ajuda a reduzir lançamentos manuais e permite que algumas informações sejam enviadas ou consultadas automaticamente.
Para que a API pode ser usada
A API pode ser usada para criar fluxos de integração conforme a necessidade da agência e a disponibilidade técnica do recurso.
Com a API do Monde, é possível:
A configuração exata depende do processo que a agência deseja automatizar e da análise técnica da integração.
Observação sobre a API de Vendas
A API de Vendas do Monde é um recurso específico para consulta de dados de vendas por meio de integração externa.
Ela pode ser utilizada, por exemplo, por clientes que desejam:
Conectar dados do Monde a ferramentas de BI;
Criar dashboards;
Consultar informações de vendas;
Realizar análises externas;
Integrar dados de vendas com outras ferramentas.
Importante
Neste momento, a API de Vendas é voltada para consulta de dados.
Isso significa que ela pode permitir a leitura de informações de vendas, mas não deve ser considerada automaticamente disponível para cadastro de vendas por sistemas externos.
Como solicitar informações sobre API
Para solicitar informações sobre API, entre em contato com a equipe Monde.
A solicitação será direcionada para avaliação comercial e técnica:
A disponibilidade, as condições de uso e possíveis cobranças devem ser verificadas com o time Comercial da Monde.
Essa análise é necessária para verificar:
Qual API a agência deseja utilizar;
Qual processo será automatizado;
Se o recurso está disponível para o cenário solicitado;
Se há necessidade de contratação adicional;
Quais são os próximos passos para configuração.
Exemplos de uso da API
A agência pode configurar a integração da forma que fizer mais sentido para sua operação.
Alguns exemplos:
Criar apenas o cliente no Monde;
Criar tarefas sem cadastrar o cliente;
Criar cliente e tarefa ao mesmo tempo;
Consultar dados de vendas para análise externa;
Alimentar ferramentas de BI ou dashboards;
Montar fluxos personalizados conforme a necessidade da agência.
Exemplo
Se a agência possui um formulário no site para solicitação de orçamento, a integração pode ser usada para enviar dados desse formulário ao Monde.
Dependendo da configuração, o sistema externo pode:
Criar o cadastro do cliente no Monde;
Criar uma tarefa para o vendedor;
Registrar informações básicas para iniciar o atendimento.
Assim, o time reduz retrabalho e evita preencher novamente dados que o cliente já informou.
Como configurar a integração
A configuração da API deve ser feita por uma pessoa com conhecimento técnico.
Para realizar a integração:
Procure um técnico ou desenvolvedor de sua confiança;
Compartilhe com ele a documentação da API do Monde;
Explique qual processo deseja automatizar;
Defina com o técnico quais dados serão enviados ou consultados;
Valide com a equipe Monde a disponibilidade da API desejada, quando necessário.
👉 Todas as informações técnicas necessárias estão disponíveis na nossa documentação da API.
Documentação da API
A documentação da API contém as informações técnicas necessárias para que o desenvolvedor consiga configurar a integração.
Nela, o técnico poderá consultar:
Endpoints disponíveis;
Métodos de requisição;
Formato dos dados;
Autenticação;
Exemplos de uso;
Retornos esperados;
Possíveis erros.
Se você não é desenvolvedor, recomendamos compartilhar a documentação com o responsável técnico pela integração.
Como gerar o token de acesso à API
O token de autenticação é obrigatório para utilizar a API.
Ele funciona como uma chave de acesso à base da agência no Monde.
Por segurança, o token deve ser usado apenas pela pessoa ou sistema responsável pela integração.
Antes de começar
Para gerar o token, é necessário ter:
Usuário administrador do Monde;
Senha de acesso ao sistema;
Endereço do servidor Monde da agência.
Se você não souber o endereço do servidor, consulte a orientação correspondente ou entre em contato com o Suporte Monde.
1. Monte o login corretamente
O login deve estar neste formato: usuario@endereco.monde.com.br
Exemplo: paulo.silva@happytours.monde.com.br
2. Acesse o endpoint de autenticação
O desenvolvedor deve fazer uma requisição usando o método POST
Endpoint:
https://SEU-ENDERECO/api/auth/token
Substitua SEU-ENDERECO pelo endereço correspondente ao servidor Monde da agência.
3. Informe os dados de acesso
No corpo da requisição, em formato JSON, informe:
{ "username": "seu_usuario@endereco.monde.com.br", "password": "SUA_SENHA" }4. Envie a requisição
Se os dados estiverem corretos, a API retornará um token de acesso.
Exemplo de retorno:
{ "token": "seu_token_aqui" }5. Use o token nas próximas requisições
Em todas as requisições da API, inclua o token no cabeçalho de autorização.
Formato:
Authorization: Bearer SEU_TOKEN
Validade e segurança do token
O token tem validade de 1 hora.
Após esse período, será necessário gerar um novo token.
Cuidados importantes
Apenas usuários administradores podem gerar o token;
Não compartilhe o token com terceiros sem necessidade;
Não publique o token em locais públicos;
Não envie o token em conversas abertas ou canais não seguros;
O token permite acesso à base da agência durante o período de validade.
Erros comuns ao gerar o token
Durante a autenticação, alguns erros podem ocorrer.
Erro | O que pode significar |
401 Unauthorized | Login ou senha incorretos |
403 Forbidden | O usuário informado não é administrador |
404 Not Found | Endpoint incorreto ou endereço do servidor incorreto |
Se o erro continuar, revise os dados utilizados na requisição e confirme se o endereço do servidor está correto.
Dúvidas frequentes
A API cadastra vendas automaticamente?
No momento, a API de Vendas é voltada para consulta de dados.
Ela não deve ser considerada automaticamente disponível para cadastro de vendas por sistemas externos.
Caso a agência tenha interesse nesse tipo de integração, a solicitação deve ser avaliada com a equipe Monde.
A API de Vendas pode ser usada para BI?
Sim, a API de Vendas pode ser usada para consulta de dados, conforme disponibilidade e liberação específica.
Ela pode apoiar integrações com ferramentas de BI, dashboards e análises externas.
A API está inclusa no plano?
Não. O uso da API pode depender de contratação adicional e avaliação comercial.
Para confirmar disponibilidade e condições de uso, entre em contato com a equipe Monde.
Preciso de um desenvolvedor para usar a API?
Sim. A API é um recurso técnico e deve ser configurada por um desenvolvedor ou profissional com conhecimento em integrações.
Posso compartilhar meu token com qualquer pessoa?
Não. O token funciona como uma chave de acesso à base da agência no Monde.
Compartilhe apenas com o responsável técnico pela integração e evite enviar por canais inseguros.
Artigos com assuntos relacionados
Resumo final
A API do Monde permite integrar o sistema com sites, ferramentas externas e outros sistemas, ajudando a automatizar processos e reduzir retrabalho.
Com ela, é possível cadastrar clientes, criar tarefas, consultar ou registrar cidades e consultar vendas, conforme disponibilidade técnica e contratação.
A API de Vendas é voltada para consulta de dados e pode ser usada em integrações com BI, dashboards e análises externas. O uso depende de liberação específica e pode ter cobrança à parte.
Para utilizar a API, a agência deve contar com apoio de um técnico ou desenvolvedor, consultar a documentação e gerar um token de acesso com usuário administrador.
