📄️ Visão geral
Para facilitar a utilização e o entendimento das APIs do grupo Magalu, criamos este guia explicativo sobre as principais funcionalidades. É fundamental entender os conceitos da estrutura para garantir que a sua aplicação seguirá as boas práticas de desenvolvimento e será bem projetada.
📄️ Paginação, filtros e ordenação
Nessa página detalharemos o padrão de paginação, filtro e ordenação.
📄️ IDs dos canais de venda
Com as novas APIs do Magalu você poderá segmentar os dados por canal de venda utilizando o atributo channel no payload das chamadas. Esse atributo receberá o id que representa o canal de venda.
📄️ Retornos de HTTP
As APIs seguem um padrão de status em comum, ou seja, o comportamento de possíveis tratativas é igual para todos os projetos incluídos neste portal.
📄️ Estrutura de erros
Estrutura da mensagem de retorno
📄️ Tipos de campos
A partir do pressuposto de que os tipos de campos fazem parte do contrato da API, entendemos que estes precisam ser claros, objetivos e estruturados.
📄️ Identificador de requisições
X-Request-ID é um header que vem no retorno de uma chamada para as APIs e ajudará em casos de debug e verificação de LOGs. É muito imporante que ao solicitar um suporte seja informado o X-Request-ID.
📄️ Rate limit
Tem como objetivo controlar a taxa de tráfego ou solicitações que um servidor recebe. Geralmente é usado para evitar que um único cliente ou grupo de clientes sobrecarregue o servidor com muitas solicitações, o que poderia interromper a capacidade do servidor de responder a outros clientes em tempo hábil.
📄️ Webhooks
Um webhook é uma maneira eficiente de receber notificações e dados em tempo real de sistemas externos.