Características clave
La documentación de Swagger/OpenAPI ofrece esquemas completos de definición de API, grupos de API organizados y una potente función de búsqueda para ayudar a los desarrolladores a encontrar y comprender rápidamente las API REST del sistem Sterling™ Order Management.
Esquemas completos de definición de la API
Todas las API incluyen información detallada sobre el esquema.
Esquema de solicitud
- Nombres de los campos : Todos los parámetros de entrada están claramente etiquetados.
- Tipos de datos : cadena, número, booleano, matriz y objeto.
- Campos obligatorios : Etiquetas visuales «required» en los campos obligatorios.
- Descripciones : Contexto empresarial de cada campo.
- Restricciones : límites de longitud, patrones y valores permitidos.
- Estructuras anidadas : objetos complejos con varios niveles.
Esquema de respuesta
- Estructura completa : definición completa del objeto de respuesta.
- Tipos de datos : información precisa sobre los tipos de todos los campos.
- Descripciones : Significado de cada campo de respuesta.
- Ejemplos : Ejemplos de cargas útiles de respuesta.
Grupos de API organizados
Las API se han dividido en grupos lógicos para facilitar la navegación.
| Grupo | Descripción | Ejemplos de API |
|---|---|---|
| YCP - Application Platform | API de la plataforma principal para la gestión de pedidos, el inventario y los clientes. | getOrderDetails, checkInventory, manageCustomer |
| YCD - Complemento de aplicación | Funciones adicionales de la aplicación y gestión de la competencia. | getCompetitor, postCompetitor |
| OMP - Distributed Order Management | Coordinación de pedidos en múltiples nodos y perspectivas prometedoras. | promiseOrder, allocateOrder |
| INV - Global Inventory Visibility | Visibilidad del inventario en todas las empresas. | getInventoryAvailability, reserveInventory |
| WMS - Gestión de almacenes | Operaciones de almacén y gestión de pedidos. | createReceipt, createPickTicket, confirmShipment |
| YSC - Gestión de la cadena de suministro | Planificación y ejecución de la cadena de suministro. | getSupplyChain, updateSupplyPlan |
| YCM - Gestión de catálogos | Catálogo de productos y gestión de artículos. | getItem, updateItem, manageCategory |
| YDM - Gestión de entregas | Programación y seguimiento de envíos. | scheduleDelivery, trackDelivery |
| YPM - Gestión de precios | Normas y cálculos de precios. | getPrice, applyPricing |
| VAS - Servicios de valor añadido | Servicios adicionales y personalizaciones. | getService, executeService |
| VARIOS - Varios | Otras API de utilidades y de apoyo. | getSystemInfo, healthCheck |
Potente función de búsqueda
La documentación incluye una potente función de búsqueda que opera simultáneamente en todos los grupos de API.
Funciones de búsqueda
- Buscar por nombre de API : busca API por el nombre de su operación. Por ejemplo, escribe «shipment» para encontrar createShipment,, getShipmentDetails, y updateShipment.
- Buscar en todos los módulos : una sola búsqueda abarca todos los grupos de API. No es necesario que busques en cada grupo por separado.
- Filtrado basado en métodos : los resultados muestran un método de « HTTP » con codificación por colores.
- GET : Insignia verde (recuperar datos)
- PUBLICAR : Tarjeta azul (crear o enviar datos)
- PUT : Insignia amarilla (actualizar datos)
- PARCHE : Insignia roja clara (actualización parcial)
- ELIMINAR : Insignia roja (borrar datos)
- Navegación instantánea : haz clic en un resultado para cargar el grupo de API correspondiente, desplázate directamente hasta la API seleccionada y resáltala para identificarla fácilmente.
Cómo utilizar la función de búsqueda
- Escribe al menos 2 caracteres en el cuadro de búsqueda.
- Los resultados aparecen al instante mientras escribes.
- Haz clic en cualquier resultado para ir directamente a esa API.
Funciones de búsqueda
- Atajos de teclado: pulsa ESC para borrar la búsqueda.
- Autocompletado: los resultados se actualizan a medida que escribes.
- Sin tiempo de espera: resultados inmediatos.
- Botón de borrado: haz clic en ✕ para borrar el texto de búsqueda.
- Haz clic fuera: haz clic en cualquier lugar para cerrar el menú desplegable de resultados.