uindocs
Developer

Requisitos

Qué necesita tu equipo antes de escribir código, y qué se acuerda con UIN

Esta etapa no tiene código. Sirve para dimensionar el esfuerzo y para dejar acordado lo único que UIN necesita de tu lado.

Dimensionamiento

No hay nada que instalar, ni componente que desplegar en tu infraestructura. Son llamadas HTTP contra la API de UIN, y la integración mínima son tres: alta de usuario, emisión de un evento y lectura del feed.

El esfuerzo real está en las pantallas de tu app, que son responsabilidad de quien la desarrolla.

Requisitos técnicos mínimos

RequisitoDetalle
Backend con salida HTTPSLos llamados salen de tus servidores hacia el dominio de la API de UIN. Requiere habilitar el tráfico saliente si tenés lista blanca.
Gestor de secretosLa credencial es de servidor y nunca viaja dentro de la app.
Identificador estable por usuarioAlcanza con el que ya usás internamente. Ver Account.
Un punto donde emitir el eventoEl lugar del código donde la acción se confirma. El llamado se emite fuera de la transacción principal.
Clave de idempotencia por operaciónDerivada del id de la operación de tu sistema. Ver Idempotencia.
Capacidad de reintento y registroCada error trae un traceId; guardalo junto al usuario y el momento.
Front capaz de renderizar cuatro tipos de ítemMisión, reto, racha y rutina se pintan distinto. Ver Progreso y recompensas.
Conversión de fechas UTCLas fechas límite llegan en UTC y se muestran en la zona del usuario.
Un endpoint receptorSolo si preferís no esperar la respuesta del evento y usar el camino asincrónico.
Acceso al ambiente de sandboxLa URL y las credenciales te las entrega tu administrador. Pedilas antes de empezar.
Un ambiente de QA propioPara probar contra el sandbox de UIN antes de tocar producción.

La credencial nunca se embebe en la app. Una credencial distribuida en un binario móvil es una credencial pública. Si la app necesita leer el progreso, el llamado sale de tu backend, no del dispositivo.

El catálogo de eventos

Es lo único que UIN necesita de tu equipo técnico para armar una campaña:

  • Qué programmaticCode puede emitir tu plataforma.
  • Qué acción representa cada uno.
  • Si viaja con monto.

Con eso, el resto se configura desde el Control Center sin tocar tu integración.

Mapeá generosamente desde el principio. Si más adelante el negocio pide premiar una acción que tu sistema todavía no emite, ahí sí hay desarrollo de tu lado.

Ver Emitir eventos para las convenciones de nombre y qué acompaña a cada evento.

Qué sigue

Con el catálogo acordado, pedí acceso al Control Center de sandbox y generá tu primera API key: Credenciales.

On this page