Neste artigo, vamos abordar os principais pontos sobre o funcionamento da API V3 da Ideris. Acompanhe a explicação!
Protocolo de Comunicação
A API utiliza o protocolo REST (Representational State Transfer) baseado em HTTP 1.1, um padrão amplamente usado por ser simples e eficiente.
- Formato dos Dados: As informações são enviadas e recebidas no formato JSON (JavaScript Object Notation), que é fácil de ler e interpretar tanto por humanos quanto por máquinas.
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.
Requisitos de Segurança
Para garantir segurança, todas as requisições à API devem incluir uma chave de autorização (Authorization) no cabeçalho HTTP.
Passo a passo:
-
Formato do cabeçalho:
- O campo Authorization deve conter o valor:
Bearer valor_do_token
- Exemplo:
Authorization: “Bearer abc123xyz”
-
Como obter o token:
- O token é gerado seguindo o protocolo OAuth 2.0.
- Esse processo exige a solicitação pelo integrador e aprovação pelo administrador do sistema.
-
Por que o token é necessário?
- Ele identifica o sistema que está acessando a API.
- Garante que apenas sistemas autorizados consigam utilizar os serviços.
Mais detalhes sobre esse processo podem ser encontrados na seção Integração da documentação.
Controle de Requisições (Throttling)
Para manter a estabilidade do sistema, existe um limite de chamadas à API:
- Padrão: 50 requisições por minuto (ou 3.000 por hora para cada endpoint).
- Cenários específicos: Em alguns casos, o limite pode ser menor, especialmente quando o Ideris depende de serviços externos, como os marketplaces.
- Necessidade de ajustes: Caso precise de um limite diferente, entre em contato com o suporte via chat.
Com essas informações, você estará mais preparado para começar a integração com a API V3 do Ideris.
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!