A API (Application Programming Interface, ou Interface de Programação de Aplicativos) é um conjunto de regras e protocolos que permitem a comunicação entre diferentes sistemas.
No contexto do Movidesk, a API possibilita que seu sistema se conecte ao Movidesk para automatizar tarefas e obter dados, usando métodos como GET, POST e PATCH.
Um exemplo real seria um sistema de gestão que utiliza a API do Movidesk para consultar os tickets recebidos pelo suporte. Quando um cliente abre um chamado no Movidesk, a API permite que o sistema interno da sua empresa consulte esses tickets automaticamente, trazendo informações como status, prioridade, descrição e a data de abertura. Dessa forma, o time de suporte pode acompanhar e atualizar os chamados diretamente no seu próprio sistema, sem precisar acessar o Movidesk manualmente.
Você pode usar nossa API para executar uma série de ações automaticamente, como:
Consultar tickets: Use o método GET para recuperar dados de um ou mais tickets.
Alterar tickets: O método PATCH permite fazer atualizações nos tickets.
Inserir novos dados: O método POST possibilita a adição de informações no sistema.
Além disso, você pode criar aplicações próprias para consumir nossa API, integrando-a ao seu sistema interno e garantindo que as informações estejam sempre atualizadas.
Como começar a usar a API do Movidesk?
Para utilizar a API do Movidesk, você precisará de uma chave de autenticação chamada Token, que é única para cada cliente. Siga os passos abaixo para encontrá-lo:
Acesse o menu Configurações.
Vá até Conta > Parâmetros.
Na aba Ambiente, role até o final da página para encontrar o Token. Copie a chave fornecida.
Com a chave de autenticação em mãos, escolha uma ferramenta para testar a API. No Movidesk, recomendamos o Postman, um software amplamente utilizado para testar e manipular APIs com facilidade.
Para teste, siga as instruções:
Abra o Postman e crie uma nova requisição.
No campo da URL, insira o endpoint da API que você deseja consultar, incluindo o token como parâmetro.
Exemplo para consulta de tickets:
https://api.movidesk.com/public/v1/tickets?token={token}
Escolha o método HTTP adequado (por exemplo, GET para consultar dados).
Clique em Send para enviar a requisição à API.
A API irá retornar uma resposta em formato JSON contendo os dados solicitados, como a lista de tickets no exemplo. Verifique os campos retornados para garantir que a integração está funcionando corretamente.
Caso o teste tenha obtido sucesso, você pode integrar esse processo ao seu próprio sistema usando o token para automatizar chamadas à API conforme necessário.
Dica: Acesse este link e veja todas as APIs existentes do Movidesk.
Administração de APIs no Movidesk
A administração da API envolve gerenciar como e quando suas integrações acessam os dados.
Aqui estão algumas práticas importantes para garantir o uso correto:
Limite de requisições: Para manter a estabilidade do sistema, limitamos o uso da API a 10 requisições por minuto. Isso garante um uso saudável dos recursos e evita sobrecarga. Se o seu caso de uso exigir um volume maior de requisições, entre em contato com o nosso suporte para uma análise personalizada.
Controle de acessos: O token de API é a chave para realizar chamadas à API, por isso é fundamental mantê-lo seguro. Recomendamos que tokens sejam compartilhados com cautela e usados apenas pelos sistemas ou desenvolvedores autorizados.
Monitoramento e Logs: Acompanhe regularmente o uso de suas requisições à API, verificando erros ou problemas que possam surgir. O Movidesk fornece registros de requisições que podem ajudar a diagnosticar qualquer falha ou comportamento inesperado.