- Sobre a API Integration
- Consultando a Documentação
- Criando a Requisição no Postman
- Propriedades de Retorno
- Perguntas Frequentes (FAQ)
Sobre a API Integration
A API Integration foi desenvolvida para atender os cenários onde precisamos automatizar o gerenciamento dos cadastros do Checklist Fácil utilizando uma API externa.
Para consumir os dados, certifique-se de que você já possui acesso à documentação e sua Chave de API em mãos.
Consultando a Documentação
Neste exemplo, vamos considerar o cadastro de unidades. As demais possibilidades de cadastros podem ser consultadas na documentação oficial da API.
Para listar as unidades cadastradas, você deve consultar a documentação para obter o método HTTP e a URL correta para sua consulta:
Criando a Requisição no Postman
Com essas informações, você pode criar a sua requisição no Postman, selecionando o método HTTP e informando a URL completa.
Ao realizar a requisição de listagem das unidades, o sistema retornará os dados conforme o exemplo abaixo:
Propriedades de Retorno
Para qualquer requisição de lista na API, você irá obter duas propriedades principais:
- data: do tipo array, onde é exibido o objeto de retorno da lista requisitada com suas propriedades específicas.
- meta:do tipo objeto, onde são retornadas as informações sobre a paginação:
- currentPage: página consultada no momento.
- from: índice do primeiro registro retornado.
- lastPage: última página que contém registros.
- path: URL da consulta executada.
- perPage: número de registros retornados por página.
- to: índice do último registro retornado nesta página.
- total: total de registros independente da página.
Todas as listagens da API sempre serão paginadas. É importante entender e prever sua utilização ao consumir os dados.
Perguntas Frequentes (FAQ)
1. Posso alterar o número de registros por página?
Sim, as configurações de paginação podem ser consultadas na documentação técnica da API para ajustar o volume de dados.
2. Onde encontro minha chave de acesso?
A chave de API pode ser gerada dentro do painel administrativo do Checklist Fácil, na seção de integrações.
❓Tem dúvidas? Entre em contato com nosso time de suporte.