Endpoints da API
Estes sĆ£o os endpoints disponĆveis para integraĆ§Ć£o do Front End com NotificaƧƵes no Site e Caixa de Entrada Rica. Estes endpoints retornam dados para usuĆ”rios logados.
Obtendo a configuraĆ§Ć£o e autenticando o usuĆ”rio
Obter configuraĆ§Ć£o
GET https://am-events-[env].fasttrack-solutions.com/api/v1/config/[brand]
Este endpoint retorna valores de configuraĆ§Ć£o necessĆ”rios para sua marca
ParĆ¢metros de Caminho
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
brand* | String | Seu "Nome da Marca Fast Track" fornecido pelo Gerente de IntegraĆ§Ć£o |
env* | String | Ambiente atual, pode ser staging ou nada que significa produĆ§Ć£o. |
200: OK
Autenticar
POST [FUSION_URL]/Platform/LoginAuthToken
O endpoint de login que troca o sid / token de autenticaĆ§Ć£o por um objeto de usuĆ”rio.
CabeƧalhos
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authtoken* | String | O sid / token de autenticaĆ§Ć£o para autenticar o usuĆ”rio |
200: OK
Autenticar no Pusher
GET [FUSION_API]/external/pusher/[brand]?authToken=[sid]
Este endpoint Ć© geralmente consumido pelo SDK Javascript do Pusher do Front End.
ParĆ¢metros de Caminho
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
brand* | String | Seu "Nome da Marca Fast Track" fornecido pelo Gerente de IntegraĆ§Ć£o |
ParĆ¢metros de Consulta
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authToken* | String | O sid / token de autenticaĆ§Ć£o para autenticar o usuĆ”rio |
200: OK
Consumindo os dados
Obter todas as notificaƧƵes
GET [FUSION_URL]/Notifications/v2/user-notifications
Lista todas as notificaƧƵes para o usuĆ”rio autenticado. Use os parĆ¢metros de string de consulta para filtrar notificaƧƵes.
O DisplayType pode ser usado para enviar notificaƧƵes silenciosas da caixa de entrada. HĆ” uma caixa de seleĆ§Ć£o no CRM para notificaƧƵes silenciosas.
ParĆ¢metros de Consulta
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
unread-only* | boolean | Retorna apenas notificaƧƵes nĆ£o lidas |
CabeƧalhos
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authtoken* | String | sid / token de autenticaĆ§Ć£o para o usuĆ”rio atualmente logado. |
200: OK
Obter notificaĆ§Ć£o especĆfica
GET [FUSION_URL]/Notifications/v2/user-notification/[id]
Retorna uma notificaĆ§Ć£o especĆfica para o usuĆ”rio autenticado. Passe o id da mensagem na url.
ParĆ¢metros de Caminho
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
id* | Integer | O id da mensagem para recuperar |
CabeƧalhos
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authtoken* | String | sid / token de autenticaĆ§Ć£o para o usuĆ”rio atualmente logado. |
200: OK
Excluir Mensagem da Caixa de Entrada Rica
DELETE [FUSION_URL]/Notifications/v2/user-notification/[id]
Exclui uma Mensagem da Caixa de Entrada Rica para o usuĆ”rio autenticado. Para que a mensagem nĆ£o seja retornada novamente na API.
ParĆ¢metros de Caminho
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
id* | Integer | O id da mensagem para excluir |
CabeƧalhos
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authtoken* | String | sid / token de autenticaĆ§Ć£o para o usuĆ”rio atualmente logado. |
200: OK
Marcar uma notificaĆ§Ć£o como lida
POST [FUSION_URL]/Notifications/MarkNotificationAsRead
Marca NotificaĆ§Ć£o no Site ou mensagem da Caixa de Entrada Rica como lida para usuĆ”rio autenticado
CabeƧalhos
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
authtoken* | String | sid / token de autenticaĆ§Ć£o para o usuĆ”rio atualmente logado. |
Corpo da RequisiĆ§Ć£o
| Nome | Tipo | DescriĆ§Ć£o |
|---|---|---|
MessageId* | Integer | O id da mensagem para ser marcada como lida |
200: OK