Bienvenido a la API de Ordering
La API de Ordering expone recursos con alcance de proyecto para negocios, menús, productos, carritos, pedidos, usuarios, entrega, pagos, lealtad y reportes.
URL de solicitud
Las solicitudes usan esta estructura general:
https://apiv4.ordering.co/{version}/{language}/{project}/{resource}
| Segmento | Propósito |
|---|---|
version | Selecciona la versión de la API, como v400. |
language | Selecciona el idioma de respuesta; no cambia el contrato de operación. |
project | Identifica el proyecto de Ordering. |
resource | Identifica el recurso de API solicitado. |
Usa valores específicos del proyecto suministrados mediante un entorno aprobado. Nunca copies credenciales, identificadores del proyecto ni datos de clientes de los ejemplos de documentación.
Autenticación
Cada operación define sus requisitos de autenticación, que pueden usar un token bearer, una clave de API, cualquiera de las dos alternativas o ninguna autenticación a nivel de operación.
Para conocer el contexto y las recomendaciones de privilegio mínimo, consulta Autenticación de usuarios y Clave de API de usuario. Mantén las claves y los tokens de API del lado del servidor y fuera del control de código fuente, los paquetes del navegador, las capturas de pantalla y los registros.
Respuestas y consultas
Muchas operaciones usan una estructura de respuesta con error y result. Cada operación especifica sus campos de respuesta, el comportamiento de los códigos de estado HTTP, la paginación, los filtros y la expansión de relaciones.
El resumen de la API presenta conceptos comunes de URL y consulta. Las guías de Paginación y Filtrado describen estos conceptos sin reemplazar los esquemas de operación.
