Índice

1. Obter url e configurações da API MIAW após habilitado 

2. Cadastro de JSON Web Key Sets (JWK) para autenticação 

3. Habilitar “Verificação de usuário” canal MIAW do Blip 

4. Vincular JWK cadastrado ao canal MIAW do Blip 

5. Configurações do Blip para integração com MIAW SalesForce 

6. Configuração do “SalesforceMessaging.RoutingAtributtes” 

Contexto

Estamos disponibilizando uma nova documentação para apoiar as marcas que hoje utilizam a antiga integração via API da Salesforce LiveAgent. O objetivo é facilitar a transição para o MIAW, garantindo que a integração continue funcionando de forma estável e alinhada ao padrão atual da plataforma.

Confira a documentação completa da API no site da Salesforce
https://developer.salesforce.com/docs/service/messaging-api/references/miaw-api-reference?meta=Summary

Obter url e configurações da API MIAW após habilitado

Acessar as Configurações do Salesforce:

No Salesforce, navegue até a seção de "Configuração" (Setup).

Utilize a barra de pesquisa rápida (Quick Find) e digite "Embedded Service" ou "Serviço Incorporado".

Clique em "Embedded Service Deployments" (Implantações de Serviço Incorporado) ou similar.

Localizar o Aplicativo MIAW:

Na lista de implantações de serviço incorporado, localize e clique no nome da sua implantação do MIAW configurada para o Blip.

Obter Endpoint URL, OrganitaionId e DeveloperName:

Dentro da página de detalhes da implantação do Embedded Service, você encontrará a "Code Snippet". Clique no botão “Install Code Snippet”.

No JSON haverá as 3 informações, anote-as para posteriormente usarmos nas configurações do Blip:

OrganizationId

DeveloperName

Url (url base da API MIAW)

Cadastro de JSON Web Key Sets (JWK) para autenticação

 Para configurar o JWK do Blip no Salesforce, siga os passos abaixo:

No Salesforce, navegue até a seção de "Configuração" (Setup).

Utilize a barra de pesquisa rápida (Quick Find) e digite "Messaging for In-App and Web User Verification".Clique em "Novo Conjunto de Chaves Web JSON".

No Grid “JSON Web Keysets” clique no botão “New Keyset”

Preencha o formulário:

Name: [escolha do usuário]

API Name: [escolha do usuário]

JSON Web Key Issuer: blipsalesforce

Type: selecionar Endpoint

Endoint URL: https://blipmediastore.blip.ai/permanent-public-jwk-salesforce/blipai-SalesforceJWK.json

Clique em "Save".

Habilitar “Verificação de usuário” canal MIAW do Blip

Para habilitar a verificação de usuário no canal "Messaging for In-App and Web" (MIAW) do Blip, siga os passos abaixo:

No Salesforce, navegue até a seção de "Configuração" (Setup).

Utilize a barra de pesquisa rápida (Quick Find) e digite "messaging settings" e clique no menu encontrado.

Clique no menu no final do grid para editar o canal MIAW configurado para integração com o Blip.

Marque o checkbox "Add User Verification", clique no botão "Edit".

Defina o tempo de duração do token no campo “Authorization Token Expiration Time for Verified Users”

Clique no botão "Save" no final da página.

Vincular JWK cadastrado ao canal MIAW do Blip

 Para configurar o JWK no canal , siga os passos abaixo:

No Salesforce, navegue até a seção de "Configuração" (Setup).

Utilize a barra de pesquisa rápida (Quick Find) e digite "messaging settings" e clique no menu encontrado.

Clique no nome do canal MIWA configurado para integração com o Blip

No final da página, no grid “User Verification Configuration” clique no bot “New”

Preencha o formulário:

Keyset: selecione o keyset que foi cadastrado no passo 2

Configuration Name: [escolha do usuário]

Checkbox “Active”: marcar

Clique no botão "Save" no final da página.

Configurações do Blip para integração com MIAW SalesForce

Acesse as “Configurações avançadas” do bot que deseja conectar a um canal configurado no SalesForce.

Abaixo estão detalhadas cada configuração que devem ser inseridas com domínio “postmaster@desk.msging.net”, juntamente com as orientações de como obter o valor no SalesForce e seu objetivo.

DefaultProvider

Definir exatamente o seguinte valor (manter letras maiúsculas): SalesforceMessaging

SalesforceMessaging.ApiEndpoint

Endpoint para enviar dados e solicitações do Blip para o Salesforce

Composição do valor de “Url” obtido no step 1 deste manual + um sufixo:

[url] + “/iamessage/api/v2”

SalesforceMessaging.SseEndpoint

Endpoint de conexão persistente para o Blip receber dados do Salesforce

Composição do valor de “Url” obtido no step 1 deste manual + um sufixo:

[url] + “/eventrouter/v1/sse”

SalesforceMessaging.OrganizationId

Valor de identificação da Org do canal MIAW

Usar o valor de “OrganizationId” obtido no step 1 deste guia

SalesforceMessaging.DeploymentId

Valor de identificação da Developer Name do canal MIAW

Usar o valor de “DeveloperName” obtido no step 1 deste guia

SalesforceMessaging.AppName

Valor para identificar o App da integração na chamada do endpoint de autenticação

Pode ser definido com qualquer valor

SalesforceMessaging.Queues

Parametrização das filas existentes no SalesForce, as quais poderão ser setadas no ticket durante o transbordo da  conversa para o atendimento humano.

As filas cadastradas aqui serão listadas para uso na criação de “regras de atendimento”.

Cadastrá-las separadas por “,”

SalesforceMessaging.TtlCacheToken

Tempo que o token de autenticação é guardado em cache para reutilização

Este cache evita chamadas excessivas ao Salesforce para solicitação de token JWT a cada operação.

Recomenda-se configurar um valor de tempo um pouco menor que o tempo configurado no salesforce no step 3.2 (item 5) deste guia

O formato é “hh:mm:ss” (Ex.: 00:30:00)

SalesforceMessaging.RoutingAtributtes

Vide tópico 6. Configuração do “SalesforceMessaging.RoutingAtributtes” abaixo

Exemplo de cadastro das configurações:

Configuração do “SalesforceMessaging.RoutingAtributtes”

O principal objetivo do routingAttributes é enriquecer o contexto do atendimento humano antes mesmo do agente iniciar a interação.

O routingAttributes é um objeto JSON informado na criação de conversas no Salesforce MIAW, atuando como um contêiner para dados adicionais que precisam ser transmitidos do Blip para o Salesforce. Ele serve como um mecanismo para injetar informações contextuais no momento da inicialização de um chat.

Quando uma conversa é criada através do endpoint /iamessage/api/v2/conversation, o campo routingAttributes permite que você envie pares de chave-valor que representam dados específicos da sessão ou do usuário. Esses dados não são apenas armazenados, mas são lidos e mapeados no "Pre-Chat Form" (ou formulário de pré-atendimento) configurado no Salesforce.

Mapeamento com o Pre-Chat Form: No Salesforce, o "Pre-Chat Form" é configurado para identificar e extrair esses atributos. Você pode mapear as chaves para campos específicos dentro do Salesforce.

Ref.: https://help.salesforce.com/s/articleView?id=service.miaw_map_messaging_2.htm&type=5

Orientações de configuração no Blip:

A configuração no Blip é um mapeamento DE-PARA de dados do Ticket, ou Contato do Ticket, para preenchimento das chaves do objeto routingAttributes enviado na API de abertura da conversa.

Regra para preenchimento do JSON de configuração (mapeamento origem Blip/destino pre-chat):

Enviar um texto fixo:

“static.[texto fixo]”: [“var pre-chat 1”,...]

Enviar uma informação extraída do ticket (ex.: nome da fila):

“Ticket.[atributo de ticket]”: [“var pre-chat 2”,...]

Enviar uma informação extraída do contato (ex.: nome do contato):

“Contact.[atributo do contato do ticket]”: [“v pre-chat 3”, “v pre-chat 4”,...]

Enviar uma informação extraída dos “Extras” do contato:

“Contact.Extras.[chave do extras do contato]”: [“var pre-chat 5”,...]

Exemplo JSON configuração “SalesforceMessaging.RoutingAtributtes” no Blip:

{

    "static.Microsoft Bot Framework": ["userAgent"],

    "Ticket.Team": ["queueId"],

    "Contact.Name": ["visitorName"],

    "Contact.Extras.accountId": ["accountId", "leadId"], //uma ou mais chaves de saída

    "Contact.Extras.objetivo": ["goals"]

}

Exemplo JSON saída do Blip que será recebido no Salesforce:

"routingAttributes": {

"userAgent": "Microsoft Bot Framework",

"queueId": "fila 1",

"visitorName": "daniel couto",

"accountId": "88888888",

"leadId": "88888888",

"goals": "lazer"

},

 Para mais informações, acesse a discussão sobre o assunto em nossa comunidade ou os vídeos no nosso canal. 😃