Este artigo também responde a:
Como integrar o Monde com o site ou outros sistemas da agência?
O que dá para fazer com a API do Monde?
Onde fica a documentação da API do Monde?
Por onde começo a integração com a API do Monde?
A API do Monde tem custo à parte?
O que você vai resolver
Neste artigo, você vai aprender o que a API do Monde permite automatizar, como começar a integração e o que entregar a quem vai montá-la.
Público-alvo: proprietários e administradores da agência.
Requisitos: usuário com Acesso Total ao sistema, e a definição do processo que a integração vai automatizar.
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
Um sistema externo conectado à API tem acesso a boa parte do que a agência faz no Monde, e monta os fluxos de integração conforme a necessidade da operação.
Com a API do Monde, por exemplo, é possível:
Cadastrar e consultar vendas, inclusive enviar anexos para elas;
Cadastrar e consultar pessoas, que são os clientes da agência;
Consultar o financeiro: contas a pagar e receber, movimentações de contas e categorias;
Criar e consultar tarefas para os vendedores iniciarem atendimentos;
Consultar orçamentos, viagens, produtos e notas fiscais;
Consultar os cadastros auxiliares, como cidades, moedas, formas de pagamento, centros de custo, vendedores e marcadores;
Consultar o histórico de alterações dos registros.
A lista completa dos recursos está na documentação da API, que é atualizada conforme novos recursos são liberados. A API está em evolução constante, e a proposta é levar para ela tudo o que já existe no Monde.
O que a integração vai realmente acessar depende do processo que a agência quer automatizar e das permissões marcadas na credencial de acesso.
Como configurar a integração
A integração é montada no sistema externo, com a credencial que a agência gera. Os passos abaixo são o que cabe à agência.
Para realizar a integração:
Acesse Cadastros > Integrações, clique em Adicionar, selecione Integração com API Monde e marque as permissões que a integração vai precisar;
Copie a credencial de acesso no momento em que ela for gerada e envie a quem vai fazer a integração, por um canal seguro;
Explique qual processo a agência quer automatizar e quais dados serão enviados ou consultados;
Compartilhe o endereço da documentação da API.
O passo a passo completo da criação da credencial, das permissões por empresa e da geração de uma nova credencial está em Como criar a credencial de acesso à API do Monde.
Documentação da API
A documentação da API contém tudo o que é preciso para configurar a integração, e está em https://web.monde.com.br/api/v3/documentation.
Nela é possível consultar:
Os recursos já disponíveis e os que ainda estão em desenvolvimento;
O formato dos dados enviados e recebidos;
Como a credencial de acesso é enviada em cada requisição;
Exemplos de uso e retornos esperados;
As mensagens de erro possíveis.
Compartilhe o endereço com quem vai montar a integração.
Cuidados importantes
A credencial de acesso dá acesso à base da agência dentro das permissões marcadas nela. Trate-a como uma senha:
Apenas usuários com Acesso Total ao sistema podem criar a credencial;
Marque só as permissões de que a integração precisa;
Não compartilhe a credencial com terceiros sem necessidade;
Não publique a credencial em locais públicos, nem a envie em conversas abertas ou canais não seguros;
A credencial não expira. Quando a integração deixar de ser necessária, desative ou exclua o cadastro dela em Cadastros > Integrações.
Como saber que a integração está pronta
Para confirmar que está tudo certo do lado da agência, acesse Cadastros > Integrações e verifique se a credencial aparece na lista com o tipo API Monde e a coluna Ativo marcada.
A confirmação final vem do outro lado: a primeira consulta à API funciona com a credencial que você enviou.
Limitações conhecidas
A credencial é exibida uma única vez, no momento em que é gerada. Se for perdida, não há como consultá-la: o caminho é gerar uma nova, e a anterior deixa de funcionar.
A API não substitui a importação de vendas de fornecedores, que continua sendo feita pelas integrações com fornecedores.
Versões da API
A versão atual da API do Monde é a v3. É para ela que aponta a documentação, e é com ela que as integrações novas devem ser construídas.
Quem já integra pela versão anterior continua funcionando normalmente, e não precisa fazer nada de imediato. Como os recursos novos entram apenas na v3, migrar é o caminho para quem quiser usar o que foi lançado depois dela.
Dúvidas frequentes
A API do Monde tem custo à parte?
Não. A API está inclusa para toda empresa com licença ativa do Monde, sem contratação adicional.
Na empresa com licença Somente leitura, a integração consulta os dados, mas não cadastra nem altera nada.
A API cadastra vendas automaticamente?
Sim. Além de consultar, a API permite cadastrar vendas a partir de um sistema externo.
Para isso, a credencial precisa ter as permissões de criação marcadas na empresa em que a venda será lançada.
A API pode ser usada para BI?
Sim. A consulta de vendas, do financeiro e dos demais cadastros pode alimentar ferramentas de BI, dashboards e análises externas.
Para esse uso, marque na credencial apenas as permissões de leitura.
Posso compartilhar minha credencial com qualquer pessoa?
Não. A credencial de acesso funciona como uma chave de acesso à base da agência no Monde.
Compartilhe apenas com quem vai montar a integração e evite enviar por canais inseguros. Se ela for exposta, gere uma nova credencial: a anterior deixa de funcionar assim que a nova é gerada.
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 e consultar vendas, pessoas e tarefas, e consultar o financeiro, os orçamentos, as viagens, os produtos e as notas fiscais da agência. A lista completa dos recursos está na documentação.
A API está inclusa para toda empresa com licença ativa do Monde, sem custo à parte.
A agência cria a credencial de acesso em Cadastros > Integrações e define, empresa por empresa, o que ela pode acessar.
A configuração é feita no sistema externo, a partir da documentação em https://web.monde.com.br/api/v3/documentation.