Recursos-chave
A documentação do Swagger/OpenAPI oferece esquemas completos de definição de API, grupos de API organizados e uma funcionalidade de pesquisa avançada para ajudar os desenvolvedores a localizar e compreender rapidamente as APIs REST do sistem Sterling™ Order Management.
Esquemas completos de definição da API
Todas as APIs incluem informações completas sobre o esquema.
Esquema de Solicitação
- Nomes dos campos : Todos os parâmetros de entrada estão claramente identificados.
- Tipos de dados : String, número, booleano, matriz e objeto.
- Campos obrigatórios : Exibição de "*" nos campos obrigatórios.
- Descrições : Contexto empresarial para cada campo.
- Restrições : limites de comprimento, padrões e valores permitidos.
- Estruturas aninhadas : objetos complexos com vários níveis.
esquema de resposta
- Estrutura completa : definição completa do objeto de resposta.
- Tipos de dados : Informações precisas sobre os tipos de todos os campos.
- Descrições : Significado de cada campo de resposta.
- Exemplos : Exemplos de cargas de resposta.
Grupos de API organizados
As APIs estão divididas em grupos lógicos para facilitar a navegação.
| Grupo | Descrição | Exemplos de APIs |
|---|---|---|
| YCP - Application Platform | APIs principais da plataforma para gestão de pedidos, estoque e clientes. | getOrderDetails, checkInventory, manageCustomer |
| YCD - Complemento de aplicativo | Recursos adicionais do aplicativo e gestão da concorrência. | getCompetitor, postCompetitor |
| OMP - Distributed Order Management | Orquestração de pedidos em vários nós e resultados promissores. | promiseOrder, allocateOrder |
| INV - Global Inventory Visibility | Visibilidade do estoque em toda a empresa. | getInventoryAvailability, reserveInventory |
| WMS - Gestão de Armazéns | Operações de armazém e atendimento de pedidos. | createReceipt, createPickTicket, confirmShipment |
| YSC - Gestão da Cadeia de Suprimentos | Planejamento e execução da cadeia de suprimentos. | getSupplyChain, updateSupplyPlan |
| YCM - Gestão de Catálogos | Catálogo de produtos e gestão de itens. | getItem, updateItem, manageCategory |
| YDM - Gestão de Entregas | Programação e rastreamento de entregas. | scheduleDelivery, trackDelivery |
| YPM - Gestão de Preços | Regras e cálculos de preços. | getPrice, applyPricing |
| VAS - Serviços de Valor Agregado | Serviços adicionais e personalizações. | getService, executeService |
| MISC - Diversos | Outras APIs utilitárias e auxiliares. | getSystemInfo, healthCheck |
Funcionalidade de pesquisa avançada
A documentação inclui um recurso de pesquisa avançado que funciona em todos os grupos de API simultaneamente.
Recursos de busca
- Pesquisar por nome da API : Encontre APIs pelo nome de suas operações. Por exemplo, digite "shipment" para encontrar createShipment,, getShipmentDetails, e updateShipment.
- Pesquisar em todos os módulos : uma única pesquisa abrange todos os grupos de API. Você não precisa pesquisar cada grupo separadamente.
- Filtragem baseada em métodos : os resultados mostram um método de " HTTP " com codificação por cores.
- GET : Emblema verde (recuperar dados)
- POST : Emblema azul (criar ou enviar dados)
- PUT : Emblema amarelo (atualizar dados)
- ATUALIZAÇÃO : Emblema vermelho claro (atualização parcial)
- EXCLUIR : Ícone vermelho (remover dados)
- Navegação instantânea : clique em um resultado para carregar o grupo de API correto, vá diretamente até a API selecionada e destaque-a para facilitar a identificação.
Como usar o recurso de pesquisa
- Digite pelo menos 2 caracteres na caixa de pesquisa.
- Os resultados aparecem instantaneamente à medida que você digita.
- Clique em qualquer resultado para acessar diretamente essa API.
Recursos de pesquisa
- Atalhos de teclado: Pressione ESC para limpar a pesquisa.
- Preenchimento automático: os resultados são atualizados à medida que você digita.
- Sem tempo de espera: resultados imediatos.
- Botão Limpar: Clique em ✕ para limpar o texto da pesquisa.
- Clique fora da janela: clique em qualquer lugar para fechar o menu suspenso de resultados.