¿Cómo hacer la integración con la API de ecopass?

¿Qué es una API?

Una API es una (Interfaz de Programación de Aplicaciones), en palabras muy simples, es un "puente" o un "mensajero" virtual que permite que dos aplicaciones (plataformas) diferentes se conecten, se hablen y compartan información entre sí de forma automática.

¿Cómo hacer la integración con la API de Ecopass?

Para realizar la integración con la API de Ecopass y conectar tus sistemas internos (como CRMs, plataformas de análisis o herramientas de marketing), debes generar tus credenciales y consultar la documentación oficial directamente desde tu cuenta. Sigue estos pasos para configurarla:

1. Inicia sesión en tu cuenta de Ecopass.
2. Dirígete a las opciones de tu perfil.
3. Ingresa a la sección API Keys.

4. Dentro de esta sección, encontrarás dos opciones clave:

→ Crear API Key: Aquí podrás generar las credenciales exactas que necesitas para realizar los llamados a la API. Desde este mismo panel también podrás desactivar o eliminar credenciales previamente creadas.

→ Documentación de la API: Al seleccionar esta opción, tendrás acceso a toda la documentación técnica y la lista completa de endpoints disponibles para operar funcionalidades como la obtención de órdenes de compra, creación de eventos, tickets, configuración de embajadores y listas de exclusión, entre otros. Documentación de la API

¿Qué puedes gestionar a través de la API?

De acuerdo con la documentación técnica de la API de Ecopass, los endpoints disponibles se dividen en las siguientes categorías principales:

• Órdenes de Compra (Purchase Orders)
  • GET /v1/events/{event}/orders    : Obtener las órdenes de un evento.
  • GET /v1/events/{event}/orders/{id}    : Obtener una orden de un evento por su ID.
• Productor (Producer)
  • GET /v1/producers    : Obtener la información del productor.
  • PATCH /v1/producers    : Actualizar la información del productor.
• Tickets Emitidos (Tickets Emitted)
  • GET /v1/events/{event}/tickets    : Obtener todos los tickets emitidos para un evento.
  • POST /v1/events/{event}/tickets    : Crear un nuevo ticket emitido.
  • GET /v1/events/{event}/tickets/{id}    : Obtener un ticket emitido específico por su ID.
• Eventos (Events)
  • GET /v1/events    : Obtener todos los eventos de un productor.
  • POST /v1/events    : Crear un nuevo evento.
  • GET /v1/events/{id}    : Obtener un evento específico por su ID.
  • PUT /v1/events/{id}    : Actualizar un evento existente.
• Tickets del Evento (Event Tickets)(Para la gestión de las categorías de entradas disponibles)
  • GET /v1/events/{event}/event-tickets    : Obtener todos los tickets disponibles de un evento.
  • POST /v1/events/{event}/event-tickets    : Crear un nuevo ticket para el evento.
  • GET /v1/events/{event}/event-tickets/{id}    : Obtener un ticket específico del evento por su ID.
  • PATCH /v1/events/{event}/event-tickets/{id}    : Actualizar un ticket existente del evento.
• Embajadores del Evento (Event Ambassadors)
  • POST /v1/events/{event}/ambassadors    : Crear un nuevo embajador.
  • GET /v1/events/{event}/ambassadors    : Obtener todos los embajadores.
  • GET /v1/events/{event}/ambassadors/{id}    : Obtener un embajador por su ID.
  • PATCH /v1/events/{event}/ambassadors/{id}    : Actualizar un embajador por su ID.
  • DELETE /v1/events/{event}/ambassadors/{id}    : Eliminar un embajador por su ID.
  • GET /v1/events/{event}/ambassadors/{id}/tickets    : Obtener los tickets emitidos a través del enlace de un embajador.
• Preguntas Dinámicas (Dynamic Questions)
  • POST /v1/events/{event}/questions    : Crear una nueva pregunta.
  • GET /v1/events/{event}/questions    : Obtener todas las preguntas.
  • GET /v1/events/{event}/questions/{id}    : Obtener una pregunta por su ID.
  • PATCH /v1/events/{event}/questions/{id}    : Actualizar una pregunta.
  • DELETE /v1/events/{event}/questions/{id}    : Eliminar una pregunta.
  • POST /v1/events/{event}/questions/{id}/tickets/{ticket}    : Asignar un ticket del evento a una pregunta.
  • DELETE /v1/events/{event}/questions/{id}/tickets/{ticket}    : Remover un ticket del evento de una pregunta.
  • GET /v1/events/{event}/questions/{id}/answers    : Obtener las respuestas de una pregunta.
  • GET /v1/events/{event}/tickets/{id}/answers    : Obtener las respuestas asociadas a un ticket específico.
• Listas de Exclusión (Exclusion List)
  • GET /v1/exclusions    : Obtener una lista paginada de asistentes excluidos por el productor.
  • POST /v1/exclusions    : Crear un nuevo asistente excluido.
  • GET /v1/exclusions/{id}    : Obtener detalles de un asistente excluido específico.
  • PATCH /v1/exclusions/{id}    : Actualizar un registro de exclusión existente.
  • DELETE /v1/exclusions/{id}    : Eliminar a un asistente excluido.
• Transmisiones (Streamings)
  • POST /v1/events/{event}/streamings    : Crear una nueva transmisión.
  • GET /v1/events/{event}/streamings    : Obtener todas las transmisiones.
  • GET /v1/events/{event}/streamings/{id}    : Obtener una transmisión por su ID.
  • PATCH /v1/events/{event}/streamings/{id}    : Actualizar una transmisión por su ID.
  • DELETE /v1/events/{event}/streamings/{id}    : Eliminar una transmisión por su ID.
• Salud del Sistema (Health)

  • GET /health    : Punto de acceso para verificar el estado de la API.

    
    

Para comenzar a utilizarla, debes iniciar sesión en tu cuenta, ir a las opciones de tu perfil e ingresar a la sección API Keys. Allí podrás generar las credenciales necesarias para conectar tus sistemas y acceder a toda la documentación técnica detallada.

Preguntas frecuentes:

¿Puedo desactivar o eliminar mis credenciales (API Keys) si hay un riesgo de seguridad?

Sí. En la sección "API Keys" dentro de tu perfil, no solo puedes crear nuevas credenciales, sino que el sistema también te brinda las opciones directas para desactivarlas o eliminarlas en cualquier momento.

¿Quien hace la integración con la API?

¿Por qué necesitas a este tipo de profesional?

Aunque generar las credenciales (API Keys) es un proceso bastante sencillo que puedes hacer tú mismo con unos pocos clicks desde la configuración de tu perfil en Ecopass, la "conexión" real entre la plataforma y tus sistemas internos (como tu CRM) requiere escribir y configurar código.