Usar la API de Ordering.co
La API de Ordering.co ofrece el mismo backend que impulsa Dashboard, de modo que puedes crear una app personalizada, un marketplace en línea o una integración sin volver a crear ese backend. Esta guía explica lo necesario antes de la primera solicitud y recorre algunos endpoints representativos; para consultar la lista autoritativa completa de operaciones, parámetros y campos de respuesta, usa API Reference.
Qué necesitas antes de empezar
-
Project ID: Identificador del proyecto, generado automáticamente a partir de su nombre. No contiene espacios y siempre está en minúsculas.
-
X-Api-Key: Clave API para una operación que declare autenticación mediante API key. Genérala desde Settings > Pro > Developers > API Keys > Add API key. Consulta Crear una API key para ver el procedimiento completo.
-
Una herramienta para solicitudes API, como Postman, que permita enviarlas e inspeccionarlas mientras desarrollas.
-
Un navegador web con herramientas para desarrolladores, como Google Chrome, útil para comparar una solicitud de Dashboard con la tuya.
La autenticación depende de cada operación. Cuando una operación declare autenticación mediante API key, envía la clave en su propio encabezado X-Api-Key:
X-Api-Key: <your-api-key>
No incluyas una API key en Authorization; usa el bloque de seguridad de cada operación en API Reference para determinar si admite API key, bearer token, ambos o ninguno. El patrón de servidor documentado es https://api.ordering.co/v400/<language_code>/<project_id>/<resource>: sustituye <project_id> por el identificador del proyecto y <language_code> por en o el código de idioma del proyecto.
Obtener la lista de pedidos
Recupera los pedidos de tu proyecto con opciones de paginación y filtrado:
https://api.ordering.co/v400/<language_code>/<project_id>/orders?orderBy=-id&page=1&page_size=10&mode=dashboard
La operación publica sus parámetros de consulta actuales, opciones de autenticación específicas de la operación, respuestas de estado y error y un sobre JSON genérico cuyo result varía según la operación. No publica una gramática completa de filtros, una lista de operadores ni un catálogo de campos de resultados. Antes de construir una solicitud, consulta la operación GET /orders en API Reference.
Obtener la lista de negocios
Para consultar los parámetros de consulta publicados actualmente y el sobre genérico de respuesta, usa la operación GET /business en API Reference. No publica un catálogo tipado de campos de negocio seleccionables, reseñas, categorías ni un payload tipado de resultados.
Las capturas siguientes son ejemplos históricos de solicitudes. No definen la sintaxis de consulta, los campos seleccionables admitidos ni la estructura de respuesta actuales.
Obtener las categorías y productos de una tienda
La referencia actual documenta la recuperación de categorías y productos como operaciones separadas. Consulta la operación de lista de categorías en API Reference y la operación de lista de productos en API Reference para ver los parámetros de ruta y consulta y los sobres genéricos de respuesta publicados.
La captura siguiente es un ejemplo histórico de solicitud; no demuestra una respuesta categories anidada actual ni un contrato de campos seleccionables.
Continuar
Esta guía cubre autenticación y algunas rutas representativas de operaciones. Para consultar todas las operaciones disponibles —incluidos parámetros de solicitud, esquemas de respuesta y códigos de estado o error— usa API Reference. Si necesitas la terminología de estados operativos de Dashboard, consulta Descripción general de Orders; no sustituye el contrato de una operación API.
Para consultar la integración de Ordering.co y cómo definir su alcance por proyecto, ve a Planificar la integración de Ordering API.