Endpoints de API
Estos son los endpoints disponibles para la integración del Front End con Notificaciones en el Sitio y Bandeja de Entrada Enriquecida. Estos endpoints devuelven datos para usuarios autenticados.
Obteniendo la configuración y autenticando al usuario
Obtener configuración
GET https://am-events-[env].fasttrack-solutions.com/api/v1/config/[brand]
Este endpoint devuelve los valores de configuración necesarios para tu marca
Parámetros de Ruta
| Nombre | Tipo | Descripción |
|---|---|---|
brand* | String | Tu "Nombre de Marca Fast Track" proporcionado por el Gerente de Integración |
env* | String | Entorno actual, puede ser staging o nada que significa producción. |
200: OK
Autenticar
POST [FUSION_URL]/Platform/LoginAuthToken
El endpoint de inicio de sesión que intercambia el sid / token de autenticación por un objeto de usuario.
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
authtoken* | String | El sid / token de autenticación para autenticar al usuario con |
200: OK
Autenticar contra Pusher
GET [FUSION_API]/external/pusher/[brand]?authToken=[sid]
Este endpoint es usualmente consumido por el SDK de Javascript de Pusher del Front End.
Parámetros de Ruta
| Nombre | Tipo | Descripción |
|---|---|---|
brand* | String | Tu "Nombre de Marca Fast Track" proporcionado por el Gerente de Integración |
Parámetros de Consulta
| Nombre | Tipo | Descripción |
|---|---|---|
authToken* | String | El sid / token de autenticación para autenticar al usuario con |
200: OK
Consumiendo los datos
Obtener todas las notificaciones
GET [FUSION_URL]/Notifications/v2/user-notifications
Lista todas las notificaciones para el usuario autenticado. Usa los parámetros de cadena de consulta para filtrar notificaciones.
El DisplayType puede ser usado para enviar notificaciones silenciosas de bandeja de entrada. Hay una casilla de verificación en el CRM para notificaciones silenciosas.
Parámetros de Consulta
| Nombre | Tipo | Descripción |
|---|---|---|
unread-only* | boolean | Solo devolver notificaciones no leídas |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
authtoken* | String | sid / token de autenticación para el usuario actualmente autenticado. |
200: OK
Obtener notificación específica
GET [FUSION_URL]/Notifications/v2/user-notification/[id]
Devuelve una notificación específica para el usuario autenticado. Pasa el id del mensaje en la url.
Parámetros de Ruta
| Nombre | Tipo | Descripción |
|---|---|---|
id* | Integer | El id del mensaje a recuperar |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
authtoken* | String | sid / token de autenticación para el usuario actualmente autenticado. |
200: OK
Eliminar Mensaje de Bandeja de Entrada Enriquecida
DELETE [FUSION_URL]/Notifications/v2/user-notification/[id]
Elimina un Mensaje de Bandeja de Entrada Enriquecida para el usuario autenticado. Para que el mensaje no sea devuelto de nuevo en la API.
Parámetros de Ruta
| Nombre | Tipo | Descripción |
|---|---|---|
id* | Integer | El id del mensaje a eliminar |
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
authtoken* | String | sid / token de autenticación para el usuario actualmente autenticado. |
200: OK
Marcar una notificación como leída
POST [FUSION_URL]/Notifications/MarkNotificationAsRead
Marca una Notificación en el Sitio o mensaje de Bandeja de Entrada Enriquecida como leído para el usuario autenticado
Headers
| Nombre | Tipo | Descripción |
|---|---|---|
authtoken* | String | sid / token de autenticación para el usuario actualmente autenticado. |
Cuerpo de la Petición
| Nombre | Tipo | Descripción |
|---|---|---|
MessageId* | Integer | El id del mensaje a ser marcado como leído |
200: OK