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