Introdução
Sobre
A integração com o sistema iApp é feita através de uma API em protocolo HTTP (modelo REST), e os dados são comunicados em formato JSON. Apesar das siglas complicadas, o processo é muito simples. Seu software poderá se comunicar com nossos servidores através de requisições HTTP, de forma muito parecida com um navegador de internet.
O protocolo HTTP é utilizado pelos navegadores para se comunicar com servidores web, através dos métodos GET, POST e PUT. Você irá utilizar estes mesmos métodos para fazer leitura, cadastro e atualização de registros em nossa API.
Utilizamos o protocolo HTTPS no ambiente.
Autenticação
A segurança dos seus dados é uma das nossas maiores prioridades. Por isso nossa API possui um mecanismo de autenticação que impede que outros usuários tenham acesso e façam qualquer tipo de alteração nas informações dos seus clientes.
Este mecanismo de autenticação é baseado em tokens. Os tokens são parecidos com uma senha de acesso, mas com a vantagem de serem únicos dentro do sistema. Eles são gerados automaticamente e nunca são repetidos. Desta forma, garantimos que todos os clientes e todas as empresas parceiras possuem um token exclusivo que as identifica.
Ao fazer qualquer operação na API, você deverá enviar o seu token e secret no header do comando HTTP.
Endpoint
Para a realização das requisições você deverá utilizar o seguinte endpoint base: https://api.iniciativaaplicativos.com.br/api
Paginação
Para as requisições de listagem, é obrigatório o envio de 2 parâmetros para realizar a paginação dos resultados e evitar sobrecarga:
offset: Númerico, indica o número de resultados a ser retornado por página.page: Númerico, página a ser retornada.
Filtros
Para as requisições de listagem, é possível utilizar filtros para obter os resultados desejados. Para isso, é necessário utilizar a seguinte convenção:
- O filtros devem ser enviados no pârametro
filters, separados por;. - Cada filtro deve conter um par de
chaveevalor(separados por|), sendo as chaves possíveis descritas em cada tópico ao lado. - Valores númericos e datas devem ser enviados o valor desejado inicial e final, separados po
:. A busca será feita pelo intervalo dos dois valores. - Datas devem ter o seguinte formato:
YYYY-MM-DD
Ordenação
Para as requisições de listagem, é possível realizar a ordenação dos resultados. Para isso, é necessário utilizar a seguinte convenção:
sort_by: Campo no qual deseja realizar a ordenação.sort_type: Tipo da Ordenação: ASC - Ascendente ou DESC - Decrescente