Todas as coleções
NPS
Realizando integração utilizando API
Realizando integração utilizando API
Leonardo De Castro Zacharias avatar
Escrito por Leonardo De Castro Zacharias
Atualizado há mais de uma semana

Aqui estão algumas dicas sobre como integrar nossa plataforma com seu sistema usando a API.

Para realizar a integração entre seu sistema e nossa plataforma, utilize a API. Todos os métodos estão documentados neste site: API V2 Track.

Conforme descrito na documentação da API, a integração só é possível usando o token de autenticação. O token é responsável por autorizar a ação desejada via API. Sobre ele, considere o seguinte:

  • O token só pode ser gerado por usuários com nível de acesso de Gerente ou Administrador;

  • Cada token pertence ao usuário, não à conta. Portanto, o usuário deve estar ativo e com um dos níveis de acesso adequados.

Se sua integração não está funcionando, verifique o token primeiro. Um token inválido resultará na mensagem ""error": "Invalid Authorization Token"".

Como aplicar filtros em métodos do tipo GET

Quando usar um método GET, os filtros devem ser passados como parâmetros na URL. Os filtros possíveis estão na seção de parâmetros da documentação, após a descrição do método.

Para aplicar um filtro, adicione um ponto de interrogação após a URL do método e informe os filtros usando o símbolo & para concatenar cada parâmetro.

Exemplos:
1 - Obter opiniões de um período e exibindo os valores de tags:
A URL já com os parâmetros informados deverá ser api.tracksale.co/v2/report/answer?start=AAAA-MM-DD&end=AAAA-MM-DD&tags=true onde AAAA representa o ano, MM o mês e DD o dia.

2 - Obter o relatório de categorias dos últimos 30 dias de campanhas específicas:
O código da campanha deverá ser informado na URL através do parâmetro codes, ficando da seguinte forma: api.tracksale.co/v2/report/category?codes=1,2 , onde o retorno será o relatório de categorias das campanhas 1 e 2.

Como agendar um disparo utilizando método do tipo POST

Para agendar o disparo de uma pesquisa via API, o horário deve ser informado no formato Unix Timestamp. Use um site como https://www.unixtimestamp.com/index.php para ajudar a obter a data e horário corretos.

Ao clicar em “Convert”, o site mostrará o tempo em Unix Timestamp. O número em verde é o equivalente à data informada, a ser usado no parâmetro "schedule_time".

Após enviar a requisição, a API retornará o código do lote e a quantidade de clientes inseridos. Na plataforma, o lote será marcado como agendado.

Para agendar o disparo para vários clientes no mesmo lote, informe os clientes entre chaves na mesma estrutura do request mostrado anteriormente, separando-os por vírgula. O retorno irá informar quantos clientes foram inseridos.

Caso queira realizar o disparo imediatamente, basta informar o parâmetro "schedule_time” como sendo 0 (zero).

Caso tenha alguma dúvida, entre em contato com o nosso time de Customer Specialists pelo chat da plataforma, e-mail [email protected] ou pelo telefone: (31) 3058-0303.

Respondeu à sua pergunta?