Eventos APP

Endpoint para registro de eventos de aplicaciones móviles.

📥 Collection Postman

Descargar Collection - APP Events

URLs

Método	URL	Acción	Descripción
POST	/api/v1/app/registeruser	Registrar	Registra ID de dispositivo en FanID existente
POST	/api/v1/app/event	Registrar	Agrega eventos usando User ID

Producción:

{connect-producao}/api/v1/app

Homologación:

{connect-homologacao}/api/v1/app

Autenticación

Todas las solicitudes requieren un token de acceso obtenido en el endpoint de Security. El token debe ser enviado en el header AccessToken.

Registrar Usuario del App

Solicitud

Endpoint: POST {connect-producao}/api/v1/app/registeruser

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body (Email como identificador):

{
  "userId": "abc123def345",
  "document": "usuario@ejemplo.com",
  "documentType": 4,
  "appName": "APPNAME",
  "appPlatform": "android"
}

Body (CPF como identificador):

{
  "userId": "abc123def345",
  "document": "12345678900",
  "documentType": 1,
  "appName": "APPNAME",
  "appPlatform": "android"
}

Campos del Body

Campo	Tipo	Obligatorio	Descripción
userId	string	Sí	ID único del dispositivo
document	string	Sí	CPF o email del usuario
documentType	number	Sí	Tipo: 1 (CPF), 4 (email)
appName	string	Sí	Nombre de la aplicación
appPlatform	string	Sí	Plataforma: android, ios

Respuesta de Éxito

Estado: 201 Created

{
  "header": {
    "codigo": 1,
    "msg": "Usuario registrado con éxito"
  }
}

Agregar Eventos

Solicitud

Endpoint: POST {connect-producao}/api/v1/app/event

Headers:

AccessToken: {access_token}
Content-Type: application/json

Body (Primer acceso):

{
  "userId": "abc123def345",
  "eventName": "first_access",
  "eventValue": null,
  "eventDate": "2025-07-28T13:00:02.135Z",
  "appName": "APPNAME"
}

Body (Acceso a ruta):

{
  "userId": "abc123def345",
  "eventName": "page_access",
  "eventValue": "/wallet",
  "eventDate": "2025-07-28T13:00:02.135Z",
  "appName": "APPNAME"
}

Campos del Body

Campo	Tipo	Obligatorio	Descripción
userId	string	Sí	ID único del dispositivo
eventName	string	Sí	Nombre del evento
eventValue	string/null	No	Valor del evento (ej: ruta accedida)
eventDate	datetime	Sí	Fecha del evento (ISO 8601)
appName	string	Sí	Nombre de la aplicación

Respuesta de Éxito

Estado: 201 Created

{
  "header": {
    "codigo": 1,
    "msg": "Evento registrado con éxito"
  }
}

Ejemplo de Implementación

async function registrarUsuarioApp(datosUsuario, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/app/registeruser', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(datosUsuario)
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}

async function agregarEvento(datosEvento, accessToken) {
  const response = await fetch('{connect-producao}/api/v1/app/event', {
    method: 'POST',
    headers: {
      'AccessToken': accessToken,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify(datosEvento)
  });

  if (!response.ok) {
    throw new Error(`Error ${response.status}: ${response.statusText}`);
  }

  return await response.json();
}