Introducción a la REST API

Este artículo es una introducción para programadores que quieren conectar con la API de Easypromos para exportar los usuarios de sus promociones.

 

En este artículo describimos los métodos que ofrece Easypromos para exportar los usuarios participantes en las promociones vía API. Esta API ha sido implementada siguiendo la metodología REST y siguiendo las reglas del protocolo HTTP.

 

Consideraciones importantes:

  • La REST API únicamente está disponible para clientes con plan Corporate o Marca Blanca
  • La REST API no exporta información de promociones Premium o Básicas.

Los usos habituales de la REST API son:

  • Importar los usuarios de las promociones a una base de datos o plataforma de gestión de usuarios propiedad del cliente.
  • Poder pintar en un sitio externo los datos de una promoción como puede ser: construir una galería de imágenes con las participaciones de los usuarios, o pintar el ranking de un juego.

La forma de trabajar con la REST API es la siguiente: un desarrollador debe programar un código que consultará periódicamente la REST API para obtener los datos que necesita.

Nota: Si tu objetivo es recoger los datos de los usuarios en tiempo real, considera utilizar la funcionalidad de webhooks en vez de la API.

En este artículo te explicamos los métodos que incluye la REST API y el acceso a la especificación técnica.
 

Índice de contenidos:

 

Autenticación

Todas las llamadas a la API deberán estar autenticadas. Para ello se deberá hacer uso de un token de acceso que el administrador podrá obtener de su cuenta de Easypromos. Sigue aquí las instrucciones para obtener un access token.

 

Métodos de la API

A continuación se enumeran y describen los métodos de la REST API:

 

1. GET Api/Promotions/List: Listado de promociones

Permite obtener el listado histórico de todas las promociones que se han creado en la cuenta. Cada promoción incluye toda su información.

Recomendación: Perfecto para exportar y tener todas las promociones creadas en easypromos y así tener un control sobre aquellas promociones pasadas.

 

2. GET Api/Promotions/Single: Información promoción individual

Devuelve todas las propiedades de una única promoción. Esta llamada no incluye los usuarios.

Recomendación: Perfecto para extraer la marca organizadora de una promoción.

 

3. GET Api/Promotions/Users/List: Listado de usuarios únicos de una promoción

Este método de la API devuelve el listado de todos los usuarios únicos registrados en la promoción. En caso de una promoción con el sistema de login activado y multiparticipación, únicamente se devolverán los datos de registro del usuario.

Recomendación: Perfecto para alimentar el CRM o la herramienta de email marketing con los leads captados en las promociones.

 

4. GET Api/Promotions/Users/Single: Información de un usuario individual

Este método de la API devuelve la información de un usuario concreto de una promoción.

 

5. GET Api/Promotions/Participations/List: Listado de participaciones de una promoción

Este método de la API aplica únicamente a promociones con el sistema de login activado. Devuelve el listado de todas las participaciones de todos los usuarios. Por ejemplo en caso de una promoción tipo puzzle con múltiples participaciones diarias, el método devolverá todas las participaciones ordenadas de forma cronológica.

Recomendación: Perfecto para tener un control sobre las participaciones de tus usuarios y complementarlo con las campañas de autologin. 

 

6. GET Api/Promotions/Leaderboard: Ranking de una promoción

Devuelve la clasificación de los 100 primeros usuarios en una promoción del tipo juego. Esta llamada devuelve el listado de usuarios únicos ordenado por mejor puntuación. Únicamente se devuelven cien usuarios. Para cada usuario se incluye su información básica más su mejor puntuación.

Recomendación: Perfecto para mostrar el ranking de una promoción en una app o en una web a los participantes, con tu diseño.

 

7. GET Api/Accounts/Users: Listado de usuarios de una cuenta

Permite exportar el listado de todos los usuarios únicos registrados en las diferentes promociones de una cuenta a partir de una fecha concreta. Para cada usuario se incluye sus datos de registro, la información de la promoción por la que ingresó y la marca organizadora de la promoción. La exportación se devuelve de forma cronológica.

Recomendación: Ideal para cuentas Corporate que gestionan diferentes marcas organizadores y cada una de ellas tiene sus promociones. Permite importar con una única llamada los diferentes usuarios de las diferentes promociones en una única herramienta de CRM.

 

8. POST Api/Promotions/Autologin: Registra un nuevo usuario en una promoción

Esta llamada permite registrar un nuevo usuario en una promoción con el sistema de Login habilitado. Es el método de la API que se utiliza para promociones incrustadas dentro de una app móvil o en un entorno logueado. Ver cómo funciona el sistema de autologin.

¿Tiene más preguntas? Enviar una solicitud

0 Comentarios

Inicie sesión para dejar un comentario.