Objetivo da mudança:
O objetivo é adicionar descrições completas e claras aos campos das APIs, garantindo melhor entendimento e usabilidade pelos desenvolvedores que integram o sistema através do HubCitel. Isso facilitará a interpretação dos dados e reduzirá dúvidas durante a implementação e uso das APIs.
Instruções sobre o que configurar:
Não foi criada nenhuma configuração para essa alteração.
Instruções sobre como utilizar:
- Acessar a documentação do HubCitel.
- Localizar a API desejada na seção correspondente.
- Consultar a descrição detalhada de cada campo no corpo da requisição ou resposta.
- Exemplo para POST /api/public/v1/products/filter:
- Campo: productId
- Tipo: string
- Descrição: Identificador único do produto na base de dados.
- Exemplo: “12345”.
- Campo: productId
- Repetir o mesmo para os demais campos das APIs listadas.
- Exemplo para POST /api/public/v1/products/filter:
- Utilizar os exemplos fornecidos para estruturar suas requisições ou interpretar respostas.
Este artigo foi útil para você?
Pró
Não
Contra