API de Idenge: integra el alta de tarjetas digitales con tu software
INTEGRACIÓN
Qué puedes hacer con la API de Idenge
Si ya gestionas a tus socios, alumnos o clientes en tu propio software (un ERP, un CRM, una plataforma de gestión deportiva o académica), no hace falta exportar una hoja de cálculo cada vez que hay un alta: con la API conectas tu sistema con Idenge y cada usuario nuevo recibe su tarjeta digital en Apple Wallet o Google Wallet de forma automática, sin que nadie tenga que volver a teclear sus datos.
- Dar de alta a los usuarios de la tarjeta desde tu sistema.
- Consultar el listado de usuarios y filtrarlo por cualquier atributo (por ejemplo, el email).
- Saber si cada usuario ha instalado ya su tarjeta en el wallet.
- Guardar en cada tarjeta los datos de los campos personalizados que hayas definido en el diseño.
- Enlazar cada usuario con el identificador que ya tiene en tu plataforma.
Si prefieres empezar sin integrar nada, el alta por enlace o QR y la importación por CSV están disponibles desde el panel: te lo contamos en cómo funciona. Y la prueba no cuesta nada: gratis hasta 20 tarjetas, sin caducidad ni tarjeta de crédito.
Documentación de la API
La referencia completa (modelo de datos, autenticación, errores y ejemplos de llamadas) está en la documentación en PDF. Las claves de acceso de tu cuenta (APIKEY y APISECRET) se obtienen en la sección Perfil del panel de Idenge.
Descargar la documentación de la API (PDF)
Referencia rápida
URL base
Todos los endpoints cuelgan de https://idenge.com/api.
Autenticación
Cada llamada debe ir autenticada con las cabeceras APIKEY y APISECRET. Las dos claves están en la sección Perfil de tu cuenta.
Códigos de error
| Código | Descripción |
|---|---|
| 401 | Petición no autenticada: faltan APIKEY o APISECRET, o son incorrectas. |
| 404 | El recurso no existe. |
| 400 | Error al validar los datos; el mensaje de la respuesta indica el motivo. |
Modelo de usuario
El usuario (User) identifica a cada titular de tarjeta. Esquema:
| Campo | Tipo | Descripción |
|---|---|---|
_id | ObjectID de MongoDB | Identificador del usuario. |
name | String | Nombre del usuario. |
email | String | Email del usuario; no admite duplicados. |
phone | String | Teléfono del usuario. |
status | String | Uno de null, installed, uninstalled o deleted. |
pass | Object | Identifica la tarjeta (pase) del usuario, si la tiene. |
emailSent | Boolean | true si ya se ha enviado el correo de descarga de la tarjeta. |
customImage | String | URL de una imagen distinta para la tarjeta de este usuario (promociones). |
data | Object | Objeto clave-valor de un nivel con los datos personalizados; la clave es el ID del campo. |
externalId | String | Identificador del usuario en una plataforma de terceros (la tuya). |
createdAt | Date | Fecha de creación del usuario. |
updatedAt | Date | Fecha de la última actualización del usuario. |
passLastUpdated | Date | Fecha de la última actualización de su tarjeta. |
customer | ObjectID de MongoDB | Identifica al cliente (tu cuenta de Idenge). |
referal | ObjectID de MongoDB | Identifica a quien le refirió, si existe. |
Ejemplos de llamada
Listar usuarios:
GET /users
APIKEY: miClave
APISECRET: miSecretoListar usuarios filtrando por un atributo:
GET /users?email=persona@ejemplo.com
APIKEY: miClave
APISECRET: miSecretoEl alta de usuarios y el resto de operaciones están detalladas en la documentación en PDF.