Neste artigo, vamos explicar como utilizar o endpoint Atualização, que serve para acompanhar novidades, alterações e atualizações na API V3 do Ideris. Este endpoint também funciona como um canal de comunicação entre o time de Desenvolvimento do Ideris e os usuários da API.
Endpoint
URL:
https://apiv3.ideris.com.br/release/search
Método HTTP:
GET
Objetivo:
- Obter uma lista das últimas atualizações realizadas na API Ideris.
Orientações Gerais
-
Campos obrigatórios:
- Certifique-se de verificar todos os campos obrigatórios e suas formatações na documentação Swagger.
-
Autenticação:
- É necessário incluir no Header:
- O token de autenticação gerado pela ação de Login.
- O campo Content-Type com o valor application/json.
- É necessário incluir no Header:
-
Parâmetros opcionais de filtro:
Caso deseje refinar a busca, utilize os seguintes parâmetros:
-
Offset: Define o ponto inicial da pesquisa. Ideal para paginação.
- Exemplo:
-
Offset: Define o ponto inicial da pesquisa. Ideal para paginação.
https://apiv3.ideris.com.br/release/search?offset=10
-
Limit: Define o número máximo de itens retornados na busca (máximo permitido: 50).
- Exemplo:
https://apiv3.ideris.com.br/release/search?limit=20
Nota:
Os parâmetros de filtro são opcionais. Utilize apenas aqueles que forem necessários para sua consulta.
Controle de Requisições (Throttling)
- Você pode fazer no máximo 50 chamadas por minuto a este endpoint.
Documentação Eletrônica
A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.
- Acesso: Não é necessário token para consultar essa documentação.
- Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.
Documentação Eletrônica
A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.
- Acesso: Não é necessário token para consultar essa documentação.
- Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.
Documentação Eletrônica
A documentação completa da API está disponível em um ambiente eletrônico no endereço Swagger.
- Acesso: Não é necessário token para consultar essa documentação.
- Objetivo: Retornar exemplos de objetos padrão, permitindo que você teste as integrações sem precisar de credenciais de acesso.
Se precisar de mais ajuda com este processo, nossa equipe de suporte está pronta para atender você. É só clicar no ícone do whatsapp no canto inferior direito de qualquer página do seu painel Ideris ou abrir um ticket.
Conte sempre conosco. Até a próxima!