Ir para conteúdo principal

Como configurar a integração com o ServiceTitan e ativar solicitações de avaliação automáticas

Um guia detalhado e fácil de seguir: encontre seu Tenant ID no ServiceTitan, registre um aplicativo e escolha os cinco escopos da API em developer.servicetitan.io, gere o Client ID e o Secret, e conecte-os ao Reviewflowz.

A
Escrito por Axel Lavergne

Quando estiver tudo pronto, cada trabalho marcado como Concluído no ServiceTitan enviará automaticamente uma solicitação de avaliação para o cliente. A avaliação retornada será atribuída ao técnico que executou o serviço.

A configuração é feita em três etapas, na seguinte ordem:

  1. ServiceTitan (go.servicetitan.com), para obter o seu Tenant ID.

  2. Portal de desenvolvedores do ServiceTitan (developer.servicetitan.io), para registrar um aplicativo e conseguir sua Application Key.

  3. ServiceTitan novamente, para conectar esse aplicativo à sua conta e gerar um Client ID e um Client Secret.

  4. Reviewflowz, para inserir os quatro valores e ativar a campanha.

Você vai precisar de quatro credenciais. Três delas são imprescindíveis. Recomendo que mantenha um bloco de notas aberto enquanto faz isso.

Credencial

Origem

Tenant ID

ServiceTitan, Configurações > Integrações > Acesso a Aplicativos de API

Application Key

Portal de desenvolvedores, dentro do seu aplicativo, na seção Chaves

Client ID

Gerado ao conectar sua conta do ServiceTitan ao seu aplicativo

Client Secret

Gerado na mesma hora, mostrado apenas uma vez

Antes de começar

É necessário ter duas permissões do ServiceTitan ativas na sua conta, que devem ser ativadas por um administrador da sua equipe:

  • Gerar Chave de Aplicativo de API

  • Gerenciar Acesso a Aplicativos de API

Sem essas permissões, o portal de desenvolvedores não permite o acesso. Esta é uma regra do ServiceTitan, não nossa.

Além disso, você precisa de uma conta Reviewflowz com um plano que inclua a integração e atribuição de técnicos, além de créditos de SMS adicionais se preferir enviar mensagens de texto em vez de e-mails. Você pode realizar toda a configuração abaixo primeiro e adicionar o faturamento no final. Nada é enviado até você ativar a campanha.

Parte 1. Obtenha seu Tenant ID no ServiceTitan

O Tenant ID é o identificador da sua conta no ServiceTitan. Se você gerencia mais de uma empresa no ServiceTitan, cada uma terá o seu próprio, precisando assim de configurações separadas.

  1. No ServiceTitan, clique na engrenagem de Configurações no menu superior.

  2. No menu lateral, procure por Integrações.

  3. Acesse Acesso a Aplicativos de API.

  4. Seu Tenant ID está no canto superior direito da página. Copie-o.

Mantenha esta aba aberta. Você voltará a ela na Parte 3, e verá o mesmo número novamente sob o rótulo Vale "tenant" permitido, isso confirma que você copiou o número correto.

Parte 2. Registre um aplicativo em developer.servicetitan.io

Esta parte pode surpreender, então sugiro ler toda a seção antes de clicar em alguma coisa.

Acesse developer.servicetitan.io e faça login. A tela de login oferece quatro botões divididos em duas colunas. Escolha a coluna da direita, Clientes do ServiceTitan, e o botão escrito Login como Usuário do Ambiente de Produção. Os botões Ambiente de Integração levam a um sandbox que não consegue acessar seus dados reais.

A tela de login do portal de desenvolvedores do ServiceTitan

Faça login com suas credenciais do ServiceTitan. Logins do Enterprise Hub e do Partner Portal não são compatíveis, você deve usar um login de usuário do ServiceTitan.

Registre o aplicativo

Em Meus Aplicativos, clique em Registrar Novo Aplicativo, responda à pergunta do ServiceTitan e você será redirecionado ao formulário de registro. Os Detalhes do Desenvolvedor descrevem o software com o qual o aplicativo interage (no caso, nós), então preencha conforme abaixo:

  • Nome da Organização: Reviewflowz

  • Site da Organização/App: https://www.reviewflowz.com

  • Endereço de E-mail: [email protected]

O campo do site requer o https:// na frente. Inserir apenas www.reviewflowz.com resultará em uma rejeição do formulário.

Detalhes do Aplicativo logo abaixo referem-se ao próprio aplicativo. Dê um nome fácil de você reconhecer, por exemplo Reviewflowz. A descrição, a questão sobre construção e manutenção, e a categoria não impactam a funcionalidade do aplicativo, então aborde-as de forma simples. Clique em Gerar para o GUID de Aplicativo de Dados Externos.

O formulário de registro de novo aplicativo, Detalhes do Desenvolvedor e Detalhes do Aplicativo

Adicione seu tenant e os cinco escopos da API

Mais abaixo no formulário, localize APIs de Tenant. Insira o Tenant ID copiado na Parte 1, depois clique em Adicionar Escopos de API.

A seção de APIs de Tenant com o botão Adicionar Escopos de API

Escolha os seguintes escopos:

  • Jobs

  • Customers

  • Locations

  • Appointment Assignments

  • Business Units

O acesso de leitura é suficiente. O Reviewflowz nunca escreve nada de volta ao ServiceTitan. Cada um desses cinco escopos desempenha uma função importante, então omitir algum não impede a conexão, mas limita suas funcionalidades:

Escopo

O que ele oferece

O que acontece sem ele

Jobs

O trabalho concluído que aciona a solicitação

Nada funciona

Customers

Nome, e-mail e telefone para envio da solicitação

Nada funciona

Locations

O endereço de serviço do trabalho

Não podemos identificar qual localização executou o trabalho

Appointment Assignments

O técnico atribuído ao trabalho

Sem crédito para técnico, ou seja, sem ranking

Business Units

O nome legível da sua filial

Suas filiais aparecem como números de ID

A primeira empresa a se conectar não incluiu o escopo de Locations e perdeu todos os contatos no primeiro dia. Selecione todos os cinco.

Copie a Chave de Aplicativo

Salve o aplicativo. Em seguida, em Meus Aplicativos, cada linha apresenta três ícones na coluna Ações. O ícone de lápis abre o aplicativo para edição, e é lá que a Application Key está localizada. Copie-a. Esta é a segunda credencial.

A Application Key identifica o aplicativo, não a sua conta. Ela não muda se você adicionar tenants, e é a mesma em ambientes de integração e produção.

Parte 3. Conecte o aplicativo à sua conta do ServiceTitan

O Client ID e o Client Secret ainda não existem. Eles só são criados quando sua conta do ServiceTitan concede acesso ao aplicativo, então este passo deve ocorrer após a Parte 2, não antes.

No ServiceTitan, vá para Configurações, procure por Integrações e abra Acesso a Aplicativos de API. Esta é a mesma página de onde você copiou o Tenant ID na Parte 1, e ela lista todos os aplicativos com acesso aos seus dados.

Gerenciar Acesso a Aplicativos de API no ServiceTitan

Clique em Conectar Novo Aplicativo. Se o aplicativo aparecer na lista, selecione-o; se a lista estiver vazia, o aplicativo não possui o seu Tenant ID, volte e adicione.

O seletor Conectar Novo Aplicativo mostrando o aplicativo registrado

Selecione-o e clique em Conectar. O ServiceTitan mostra os escopos que o aplicativo está solicitando, e você precisa aprová-los. Então o aplicativo ganha uma página de detalhes próprios. Vale a pena acessar essa página. O Vale "tenant" permitido nela é o seu Tenant ID, com um botão Copiar ao lado. Se você tem dúvida sobre ter copiado o número certo na Parte 1, aqui é onde você pode confirmar. A seção Tem Acesso A lista o que o aplicativo pode acessar.

Detalhes da Aplicação mostrando o valor do tenant permitido e escopos concedidos

Gere o Client ID e o Client Secret

No portal de desenvolvedores, vá para Meus Aplicativos. Na linha do seu aplicativo, clique no ícone do meio, que se parece com um elo de corrente. Isso leva às Conexões de Aplicativo, que não estão sinalizadas.

A linha Meus Aplicativos com o ícone de Conexões de Aplicativo

Conexões de Aplicativo lista uma linha para cada tenant que conectou-se ao seu aplicativo. Nesta linha, aparecem o ID de Tenant/Rede, o Client ID e um botão Gerar para o Client Secret.

Conexões de Aplicativo com o ID de Tenant, Client ID e botão Gerar

Copie o Client ID. Clique em Gerar e copie o secret imediatamente, pois ele é mostrado apenas uma vez. Trate-o como uma senha: cole-o no Reviewflowz e em nenhum outro lugar. Nós o armazenamos criptografado e nunca o mostramos de volta para você.

Parte 4. Conecte o ServiceTitan ao Reviewflowz

  1. No Reviewflowz, vá para Integrações no canto inferior esquerdo da barra lateral.

  2. Clique em Automatizar solicitações de avaliação no canto superior direito.

  3. Procure por ServiceTitan e clique no card correspondente.

  4. Cole os quatro valores seguintes:

  5. Client ID, da Parte 3.

  6. Client Secret, da Parte 3.

  7. Tenant ID, da Parte 1.

  8. App Key, da Parte 2. É um campo opcional porque podemos usar nossa própria chave, mas você registrou um app, então cole a sua.

  9. Clique em Conectar ServiceTitan.

Verificamos as credenciais e, em seguida, o Tenant ID separadamente, então a mensagem de erro indicará qual dos dois está incorreto:

Erro

O que significa

O ServiceTitan rejeitou essas credenciais

O Client ID ou Secret estão errados, ou o secret foi regenerado após você copiá-lo

Essas credenciais funcionam, mas esse Tenant ID não

O ID pertence a um tenant diferente. Verifique novamente a Parte 1

Não conseguimos encontrar uma App Key para esta conexão

O campo App Key está vazio e não temos uma alternativa. Cole a Application Key da Parte 2

Quando tudo funciona, o card fica verde e mostra quantos trabalhos você completou nos últimos 30 dias. Isso comprova que podemos ler seus dados.

Depois, importamos seu histórico de trabalhos concluídos. Esses trabalhos passados são imediatamente computados no ranking de técnicos, e nenhum deles recebe uma solicitação de avaliação. Somente trabalhos concluídos após a conexão serão alvos de mensagens.

Parte 5. Identifique a localização a qual um trabalho pertence

Ignore esta parte se você gerencia apenas uma localização.

No painel de configurações do ServiceTitan, em Localizações, defina como determinamos qual das suas localizações realizou o trabalho:

  • Unidade de negócio, se suas unidades forem filiais. Então, vincule cada unidade de negócio a uma localização do Reviewflowz na tabela abaixo.

  • Endereço do cliente, se suas unidades de negócio forem tipos de serviços e não filiais. Utilizamos a localização mais próxima do cliente.

Também defina Recair em. Essa será a localização usada quando a unidade de negócio não estiver vinculada e o endereço não indicar proximidade com nenhuma localização.

Se a lista de unidades de negócio estiver vazia, conclua um trabalho no ServiceTitan e pressione Atualizar lista.

Parte 6. Redija a mensagem e ative a campanha

A conexão criou uma campanha rascunho chamada Solicitações de avaliação do ServiceTitan. Ela não envia nada até ser ativada.

  1. Abra a campanha e clique no ícone de engrenagem ao lado do título.

  2. Escolha o canal. O e-mail está pronto para uso. O SMS necessita de um remetente registrado, o que é um processo único que leva alguns dias. Comece com e-mail se busca rapidez.

  3. Redija sua mensagem, ou use a nossa.

  4. Defina o intervalo de atraso. Enviar 20 minutos após o fechamento do trabalho é melhor que imediatamente, pois o técnico geralmente ainda está no local.

  5. Adicione um acompanhamento, se desejar, alguns dias depois.

  6. Envie um teste para você mesmo.

  7. Clique em ativar. Confirme que possui permissão para contatar os clientes, e nós revisamos a campanha para garantir conformidade antes de liberá-la.

Após ativada, a campanha roda sozinha. Trabalhos concluídos viram contatos em Solicitações, e a mensagem é enviada após o tempo de atraso que você definiu.

Rapidez do processo

Checamos o ServiceTitan por trabalhos concluídos a cada 15 minutos. O ServiceTitan não oferece webhooks para aplicativos novos, então não enviam notificações sobre o evento, e a abordagem recomendada é mesmo a checagem periódica. Aguarde o envio dentro de cerca de 15 minutos após o fechamento do trabalho, mais o atraso que você escolheu.

Apenas o status Concluído aciona uma solicitação. Agendado, Despachado, Em Progresso, Em Espera e Cancelado não fazem isso.

O que fazer se algo der errado

O aplicativo não aparece na lista "Conectar Novo Aplicativo". Seu Tenant ID não está no aplicativo. No portal de desenvolvedores, acesse Meus Aplicativos, edite o aplicativo, seção de Tenants.

Tudo conectado, mas nenhuma solicitação é enviada. Confira três coisas nesta ordem: a campanha está ativa e não em rascunho, o status do trabalho no ServiceTitan está como Concluído, e o trabalho foi concluído após a conexão. Trabalhos concluídos antes são importados apenas para relatórios e nunca acionam envio.

Filiais aparecem como números. O escopo de Unidades de Negócio está ausente no aplicativo. Adicione-o no portal de desenvolvedores e clique em Atualizar lista no cartão de Localizações.

Avaliações não são atribuídas aos técnicos. O escopo de Atribuições de Compromisso está faltando. Trabalhos com múltiplos técnicos creditam a todos, então se apenas um técnico está faltando, pode ser que ele não tenha sido atribuído corretamente no ServiceTitan.

Você regenerou o Client Secret. Ao fazer isso, invalide o antigo. Insira o novo secret no Reviewflowz para manter a sincronização ativa.

Isto respondeu à sua pergunta?