Skip to main content
La colección de Postman cubre todos los endpoints de la Developer API: estado y autenticación, los flujos de OAuth, locales y conexiones, lectura y publicación de menús, el ciclo completo de pedidos y webhooks. Incluye scripts auxiliares para que pueda ejecutar un flujo de principio a fin sin copiar y pegar ids entre solicitudes.

​
Descarga

Colección

Todos los endpoints, cuerpos de ejemplo y scripts.

Entorno de staging

Apunta a api.staging.maple.inc; use su clave mpk_test_….

Entorno de producción

Apunta a api.maple.inc; use su clave mpk_live_….

​
Configuración

1

Importe la colección y un entorno

En Postman, use Import con el archivo de la colección y luego importe el archivo del entorno Staging (o Production). Seleccione ese entorno en el selector de entornos de la esquina superior derecha.
2

Agregue su clave de API

Abra el entorno y pegue su clave en apiKey: mpk_test_… para staging, mpk_live_… para producción. Es el único valor que debe definir para la autenticación con clave de API.
Las solicitudes envían Authorization: Bearer {{bearerToken}}. Cuando bearerToken está vacío, usa automáticamente su apiKey, así que basta con definir apiKey.
3

Confirme la credencial

Ejecute Status & Auth → Current app (/me). Un 200 con el nombre de su app, el entorno y los alcances (scopes) significa que está listo.
4

Ejecute un flujo

Ejecute Locations & Connections → List locations y luego Get location / Create connection, que están debajo: la solicitud de lista guarda el primer locationId en el entorno, así que las solicitudes siguientes funcionan directamente. El mismo encadenamiento captura orderId, subscriptionId y eventId.

​
Qué hacen los scripts

  • Respaldo de autenticación: un script previo a la solicitud de la colección usa su apiKey como token bearer, a menos que se defina un bearerToken explícito.
  • Encadenamiento de ids: las solicitudes de lista guardan en el entorno el primer id devuelto (locationId, orderId, subscriptionId, eventId) para las solicitudes que lo necesitan.
  • Captura del secreto del webhook: Create webhook subscription guarda el signing_secret de un solo uso en signingSecret (guárdelo de forma segura; se muestra una sola vez).
  • OAuth (opcional): la carpeta OAuth intercambia las credenciales de cliente por un token de acceso y cambia bearerToken a ese token automáticamente. También incluye un generador de PKCE y el intercambio del código de autorización. Vacíe bearerToken para volver a su clave de API.
Los campos de dinero son enteros en unidades menores (centavos). La solicitud de publicación de menú incluye un documento de ejemplo completo que puede adaptar. Para el detalle campo por campo, consulte la referencia de la API y El modelo de menú.