Ir al contenido
Maple

    Recursos

    Colección de Postman

    Una colección de Postman lista para ejecutar para toda la Developer API, con la autenticación y el encadenamiento de solicitudes ya configurados.

    La colección de Postman cubre la Developer API: estado y autenticación, locales y conexiones, lectura y publicación de menús, zonas de entrega, el ciclo completo de pedidos, webhooks, reservas, lista de espera y comentarios (feedback). 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.

    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 guardan en el entorno los ids que necesitan las solicitudes posteriores (locationId, orderId, subscriptionId, eventId, zoneId, holdId, bookingId, waitlistEntryId, etc.).
    • 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. OAuth todavía no forma parte de la API de disponibilidad general (vea Autenticación), así que use su clave de API a menos que Maple haya habilitado OAuth para su aplicación. Vacíe bearerToken para volver a su clave de API.