Veja como utilizar o módulo de API de Integração e automatize ainda mais os seus processos.
O que é o módulo de API de Integração?
O módulo API Integration foi desenvolvido para atender os cenários nos quais é necessário automatizar o gerenciamento dos cadastros do Checklist Fácil utilizando uma API. Com esta solução, você pode integrar o sistema com qualquer outra plataforma e realizar diversas ações, como:
- Gerar tokens;
- Buscar, inserir e atualizar dados cadastrais;
- Buscar histórico de aplicações;
- Registrar webhooks e muito mais.
Como utilizar a API de Integração?
Para consumir os dados da API de Integração, você precisa estar com acesso à documentação do módulo e com a sua Chave de API em mãos.
Para acessar a documentação, é necessário estar logado no Checklist Fácil. Faça seu login e clique no link: Acessar documentação oficial
Para facilitar o entendimento, vamos exemplificar o uso a partir do cadastro de unidades. Lembre-se que as demais possibilidades podem ser consultadas na documentação oficial.
Para listar as unidades cadastradas, consulte a documentação para obter o método HTTP e a URL que serão utilizados, conforme o exemplo abaixo:
Com essas informações, você pode criar sua requisição em ferramentas como o Postman, selecionando o método HTTP e informando a URL completa.
Dessa forma, você realizará a requisição de listagem das unidades com sucesso:
Para qualquer requisição de lista na API, você obterá duas propriedades principais:
- data: do tipo array, onde são exibidos os objetos de retorno da lista requisitada.
- meta:do tipo objeto, contendo informações sobre a paginação dos resultados, como:
- currentPage: a página consultada no momento.
- lastPage: a última página que contém registros.
- perPage: número de registros por página.
- total: total geral de registros.
Observação: Todas as listagens da API são paginadas. É fundamental prever essa estrutura ao consumir os dados para garantir que todas as informações sejam processadas corretamente.
Perguntas Frequentes (FAQ)
1. Quais métodos HTTP são suportados?
A API suporta os métodos padrão de mercado: GET para consultas, POST para criação de novos registros, PUT para atualizações e DELETE para exclusões.
2. Posso testar a API antes de programar?
Sim, você pode utilizar ferramentas como o Postman para simular as requisições e visualizar os retornos antes de iniciar o desenvolvimento no seu software.
3. O que acontece se eu não informar a página na consulta?
Caso o parâmetro de página não seja enviado, o Checklist Fácil sempre retornará automaticamente os dados correspondentes à primeira página de resultados.
❓Tem dúvidas? Entre em contato com nosso time de suporte.