Endpoints de API
Estos son los endpoints disponibles para la integraci贸n del Front End con Notificaciones en Sitio y Rich Inbox. Estos endpoints devuelven datos para usuarios que han iniciado sesi贸n.
Obtener la configuraci贸n y autenticar 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, lo 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.
Encabezados
| Nombre | Tipo | Descripci贸n |
|---|---|---|
authtoken* | String | El sid / token de autenticaci贸n para autenticar al usuario |
200: OK
Autenticar contra Pusher
GET [FUSION_API]/external/pusher/[brand]?authToken=[sid]
Este endpoint generalmente es 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 |
200: OK
Consumir 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 las notificaciones.
El DisplayType puede usarse para enviar notificaciones silenciosas de inbox. 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 |
Encabezados
| Nombre | Tipo | Descripci贸n |
|---|---|---|
authtoken* | String | sid / token de autenticaci贸n para el usuario con sesi贸n iniciada actualmente. |
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 |
Encabezados
| Nombre | Tipo | Descripci贸n |
|---|---|---|
authtoken* | String | sid / token de autenticaci贸n para el usuario con sesi贸n iniciada actualmente. |
200: OK
Eliminar Mensaje de Rich Inbox
DELETE [FUSION_URL]/Notifications/v2/user-notification/[id]
Elimina un Mensaje de Rich Inbox para el usuario autenticado. Para que el mensaje no se devuelva nuevamente en la API.
Par谩metros de Ruta
| Nombre | Tipo | Descripci贸n |
|---|---|---|
id* | Integer | El id del mensaje a eliminar |
Encabezados
| Nombre | Tipo | Descripci贸n |
|---|---|---|
authtoken* | String | sid / token de autenticaci贸n para el usuario con sesi贸n iniciada actualmente. |
200: OK
Marcar una notificaci贸n como le铆da
POST [FUSION_URL]/Notifications/MarkNotificationAsRead
Marca una Notificaci贸n en Sitio o mensaje de Rich Inbox como le铆do para el usuario autenticado
Encabezados
| Nombre | Tipo | Descripci贸n |
|---|---|---|
authtoken* | String | sid / token de autenticaci贸n para el usuario con sesi贸n iniciada actualmente. |
Cuerpo de la Solicitud
| Nombre | Tipo | Descripci贸n |
|---|---|---|
MessageId* | Integer | El id del mensaje a marcar como le铆do |
200: OK