API
      Voltar para o início
      1. CXM - Central de ajuda Track.co
      2. Track CXM
      3. API

      API

      Sobre a API Track CXM

      A documentação a seguir é uma explicação funcional sobre as opções e uso da API, para informações técnicas sobre a API, acesse:
      ​


      Documentação API Track CXM

       

      Importante: É necessário ter conhecimento técnico para implementação da API.

       

       

      Como utilizar a API na Track CXM?

      Para utilizar a API da Track CXM, acesso o menu integrações clique em configuração na sessão “API”.

       

      image.png

       

      Ative sua integração API:

       

      image.png

       

      Uma vez ativa, o sistema disponibilizará as informações de Token API e ID da organização (organization_uuid), ambas serão necessárias para gerar as requisições disponíveis.

       

      Importante: essas são informações confidenciais e não devem ser compartilhadas publicamente.

       

       

      Requisições GET

      A seguir estão listadas as requisições, suas URLs e funções que utilizam o método GET:

       

      Listar pesquisas

      • Função: O sistema disponibilizará a lista de pesquisas existentes na sua organização com nome da pesquisa e o uuid correspondente.

      • URL: https://track.co/v1/organizations//surveys

      • Link da documentação técnica: Documentação Listar pesquisas

       

      Listar atributos

      • Função: Para criar uma nova distribuição será solicitada uma lista contendo os atributos dos clientes, este endpoint disponibiliza a lista de atributos cadastrados na sua organização.

      • URL: https://track.co/v1/organizations//attributes

      • Link da documentação técnica: Documentação Listar atributos

       

      Listar templates

      • Função: Para criar uma nova distribuição será solicitada uma lista contendo os atributos dos clientes, este endpoint disponibiliza a lista de atributos cadastrados na sua organização.

      • URL: https://track.co/v1/organizations//templates

      • Link da documentação técnica: Documentação Listar templates

       

      Listar Integrações WhatsApp

       

      Listar uma distribuição

      • Função: Lista as informações das configurações de uma distribuição.

      • URL: https://track.co/v1/organizations//distributions/

      • Link da documentação técnica: Documentação Listar uma distribuição

       

      Listar todas distribuições de uma pesquisa

       

      Listar exportações

      • Função: Lista as informações das exportações criadas na organização.

      • URL: https://track.co/v1/organizations//exports/

      • Link da documentação técnica: Documentação Listar exportações

      • Informações adicionais:
        define quais são as informações que você deseja exportar, sendo cada uma delas representadas por um número:

         

        • Interactions int: 1

        • Customers int: 2

        • Distributions int: 3

        • Credits int: 4

        • Logs int: 5

        • Surveys int: 6

         

         

      Requisições POST

      A seguir estão listadas as requisições, suas URLs e funções que utilizam o método POST:

       

      Criar uma distribuição

      • Função: Criar uma nova distribuição de pesquisas por email, smslink ou WhatsApp.

      • URL: https://api.track.co/v1/organizations//distributions

      • Link da documentação técnica: Documentação Criar uma distribuição

      • Informações adicionais:

        • Importante: Ao enviar os atributos a variável deve ter o nome do atributo e não sua tag.

        • Os identificadores de templates podem ser encontrados na lista de templates ou através do endpoint “Listar templates”.

        • Na definição de canais, é necessário usar string, sendo elas: email, smslink ou whatsapp
         
         

      Exemplo:

      "distribution_channel": "email",

       

      Criar uma distribuição LinkList

      • Função: Criar uma nova distribuição de pesquisas através de uma lista de links.

      • URL: https://api.track.co/v1/organizations///distributions/createLinkList

      • Link da documentação técnica: Documentação Criar uma distribuição LinkList

      • Informações adicionais:

        • É possível definir se os links gerados serão ou não encurtados utilizando: "shortened_link": true, para link encurtado e "shortened_link": false, para link comum.

        • Caso seu processamento leve mais tempo ou extrapole o limite, você poderá configurar uma URL para receber o aviso de que seu processamento foi finalizado. Utilize o "callback_url": "...", para direcionar essa notificação.
         
         

         

      Reenviar uma distribuição

      • Função: Reenvia convites de pesquisas para clientes da distribuição que ainda não responderam.

      • URL: https://api.track.co/v1/organizations///distributions//resend

      • Link da documentação técnica: Documentação Reenviar uma distribuição

      Exportar

      • Função: Cria uma exportação das informações dos últimos 30 dias para o recurso desejado.

      • URL: https://api.track.co/v1/organizations//exports/

      • Link da documentação técnica: Documentação Exportar

      • Informações adicionais:
        define quais são as informações que você deseja exportar, sendo cada uma delas representadas por um número:

        • Interactions int: 1

        • Customers int: 2

        • Distributions int: 3

        • Credits int: 4

        • Logs int: 5

        • Surveys int: 6
         

      Para informações adicionais sobre a API acesse:

       

       

      Se você tiver alguma dúvida, entre em contato com o nosso time de Atendimento ao cliente pelo chat ali no canto inferior direito da tela ou nos envie um e-mail com sua dúvida para suporte@track.co, ou ainda pode nos ligar no telefone: (11) 4858-9924.

       

      Será um prazer te atender!