Documentación API Track NPS

La nueva versión de la API de Track NPS ha llegado. ¡Lea la documentación!

La API Track NPS fue desarrollada con la finalidad de facilitar la comunicación de informaciones entre Track.co con otros sistemas, como softwares, CRM, ERP, diversas plataformas, etc. Fue desarrollada siguiendo el modelo de comunicación RESTful con JSON.

Con ella, es posible realizar una serie de automatizaciones para realizar el seguimiento de la satisfacción de clientes en tiempo real, y también realizar consultas de datos junto a la plataforma de Track NPS, como importar el grado de satisfacción de clientes para otros sistemas.

Para la utilización de la API Track NPS es necesario realizar una configuración dentro de la plataforma. Los siguientes pasos describen cómo se puede hacer.

  1. Inicie sesión en Track NPS con una cuenta de administrador
  2. Acceso al menú “Aplicaciones” en la esquina superior derecha que se encuentra junto al nombre del usuario.
  3. Haga clic en instalar en la aplicación “API RESTful”. "API RESTful".
  4. En la pantalla de creación de API RESTful, complete todos los campos.
  5. Después de la creación del app, la clave de API se generará para su uso.
  6. Listo, su clave de API está lista para ser utilizada.

Cada endpoint tiene una URL específica, verifíquela individualmente.

La autenticación de la API se realiza desde el encabezado HTTP Api-Key, donde su valor debe ser la clave de API en Base64. Puede convertir su clave de API en Base64 a través del sitio base64encode.org.

A continuación, se describen los métodos disponibles en la API Track NPS.

  1. Listar Campañas
    GET /campaign

    Método responsable por listar todas las campañas y sus respectivas claves de acceso para los demás métodos.

    Ejemplo de retorno

    : 
    {
    "error": {
        "code": 0,
        "msg":""
    },
    "items": [
      {
            "name": "Campanha 1",
            "campaign_key": "ddd058a0dd800614b42d42c8b6a6ceee"
      },
      {
            "name": "Campanha 2",
            "campaign_key": "5551b0546cc00bc97643c4522e31c999"
      }
    ]
}
  2. Agendar Disparo
    POST /dispatch ou POST /postSaleDispatch

    Método responsable de la programación de disparos de búsquedas.

    Ejemplo de llamada: 
    {
    "campaign_key": "INSERTAR LA CLAVE DE LA CAMPAÑA DESEADA",
    "customers": [
        {
            "name":"Guilherme Tonioli",
            "email":"guilherme@tracksale.co",
            "tags" : [
                {
                    "name" : "Estado",
                    "value" : "MG"
                },
                {
                    "name" : "Ciudad",
                    "value" : "Belo Horizonte"
                }
            ]
        }
    ],
    "schedule_time": 1438291800
}

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    campaign_key String Si (si no utiliza route_key) Clave de la campaña objetivo. Obtenido por el método GET /campaign
    route_key String Si (si no utiliza campaign_key) Clave de la ruta de API. Obtenido dentro de la plataforma Track NPS.
    customers Array Si Lista de los clientes
    schedule_time Integer No Fecha/hora en el padrón timestamp (en segundos) para la programación del disparo

    customers Tipo Obligatorio Descripción
    name String No Nombre del cliente
    email String Si (para disparos vía correo electrónico) Correo electrónico del cliente
    phone String Si (para disparos vía SMS) Teléfono del cliente
    identification String No ID único del cliente
    tags Array No Etiquetas para agregar informaciones adicionales al cliente

    tags Tipo Obligatorio Descripción
    name String Si Nombre de la etiqueta
    value String Si Valor de la etiqueta


    Ejemplo de retorno

    : 
    {
    "error": {
        "code":0,
        "msg":"Disparo 'XTS123AQ' agendado!"
    }
}
  3. Insertar Respuestas
    POST /answer ou POST /postSaleAction

    Método responsable por la inserción de respuestas de clientes.

    Ejemplo de llamada: 
    {
    "campaign_key": "INSERTAR LA CLAVE DE LA CAMPAÑA DESEADA",
    "post_sale_actions":[
        {
            "name":"Carolina Ferreira",
            "email":"carolina@tracksale.co",
            "score":10,
            "justification":"Muy bien!",
            "createTime":1411506358,
            "tags" : [
                {
                    "name" : "Estado",
                    "value" : "SP"
                }
            ]
        }
    ]
}

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    campaign_key String Si (si no utiliza route_key) Clave de la campaña objetivo. Obtenido por el método GET /campaign
    route_key String Si (si no utiliza campaign_key) Clave de la ruta de API. Obtenido dentro de la plataforma Track NPS.
    post_sale_actions Array Si Lista de respuestas

    post_sale_actions Tipo Obligatorio Descripción
    name String No Nombre del cliente
    email String No Correo electrónico del cliente
    phone String No Teléfono del cliente
    identification String No ID único del cliente
    score Integer Si Nota del NPS (entre 0 y 10)
    justification String No Comentario del cliente
    createTime Integer No Fecha/hora de la respuesta en el padrón timestamp (en segundos)
    tags Array No Etiquetas para agregar informaciones adicionales al cliente

    tags Tipo Obligatorio Descripción
    name String Si Nombre de la etiqueta
    value String Si Valor de la etiqueta


    Ejemplo de retorno

    : 
    {
    "error": {
        "code":0,
        "msg":"Opiniones de clientes insertadas"
    }
}
  4. Datos de la Campaña
    GET /campaign/CHAVE

    Método que permite obtener datos de la campaña a partir de su CLAVE o por una RUTA.

    Ejemplo de llamada:
    Con la clave de la Campaña deseada:
    GET /campaign/CHAVE
    Con la ruta de la Campaña deseada:
    GET /campaign/route/ROTA

    Ejemplo de retorno

    : 
    {
    "name" : "Satisfacción de la Compra",
    "questions":
        [
            {
                "type" : "nps",
                "title" : "Qué podríamos hacer para mejorar ...",
                "question" : "En una escala de 0 a 10, cuanto...",
                "secondary" : "En pocas palabras, describa ..."
            },
            {
                "type" : "nps",
                "title" : "Qué es lo que usted particularmente recomendaría...",
                "question" : "Con base en su última compra, ..."
            }
        ]
}

Las informaciones disponibles en Track Live pueden ser consumidas a través de aplicaciones externas. Para eso, es necesario crear y configurar un nuevo Tracskale Live siguiendo las informaciones de abajo:

  1. Inicie sesión en Track NPS con una cuenta de administrador
  2. Acceso al menú “Aplicaciones” en la esquina superior derecha que se encuentra junto al nombre del usuario.
  3. Haga clic en instalar en la aplicación “API RESTful”. "Tracksale Live".
  4. En la pantalla de creación de Tracksale Live, complete todos los campos.

    Atención: apenas Tracksale Live públicos podem ser utilizados como API.
  5. Después de la creación del app, el enlace de Track Live será generado y podrá ser utilizado.
  6. Listo, su Track Live está listo para ser utilizado.

Cada endpoint tiene una URL específica, verifíquela individualmente.

A continuación, se describen los métodos disponibles en la Tracksale Live.

  1. Obtener Comentarios
    GET /comments

    Método responsable por devolver los comentarios de los clientes.

    Ejemplo de llamada 
                                    https://tracksale.co/live/9fcd63043104b23d81dd0334df6772f8/comments?start=01/01/2016&end=31/01/2016

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    start Date No Fecha inicial en el formato dd/mm/aaaa
    end Date No Fecha final en el formato dd/mm/aaaa
    limit Integer No Total de comentarios a ser devueltos. Utilice -1 para devolver todos.
    tags Boolean No Devuelve las etiquetas referentes a las respuestas
    justifReturn String No Formato de retorno de las justificaciones.
    "array" - Devuelve todas en una única array.
    "level" - Devuelve formato JSON con subniveles de justificaciones agrupadas.


    Ejemplo de retorno

    : 
    [
    {
        "time": 1454340407,
        "type": "Widget Modal",
        "name": "Carol",
        "email": "carol@tracksale.co",
        "identification": null,
        "phone": null,
        "nps_answer": 7,
        "nps_comment": null,
        "campaign_name": "NPS - Pagantes",
        "campaign_key": "f8908078aa815eb5bb52c83e2868ac42",
        "id": 6805511,
        "justifications": [],
        "picture": null,
        "tags": []
    }
]
  2. NPS
    GET /global

    Método responsable por devolver la métrica del NPS.

    Ejemplo de llamada: 
                                    https://tracksale.co/live/9fcd63043104b23d81dd0334df6772f8/global?start=01/01/2016&end=31/01/2016

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    start Date No Fecha inicial en el formato dd/mm/aaaa
    end Date No Fecha final en el formato dd/mm/aaaa
    compare Boolean No Devuelve los datos de NPS correspondiente al período anterior del filtro de la fecha.


    Ejemplo de retorno

    : 
    {
    "detractors": 2,
    "detractors_percentage": 3,
    "passives": 16,
    "passives_percentage": 23,
    "promoters": 50,
    "promoters_percentage": 74,
    "nps": 71,
    "compare": {
        "detractors": 8,
        "detractors_percentage": 13,
        "passives": 6,
        "passives_percentage": 10,
        "promoters": 46,
        "promoters_percentage": 77,
        "nps": 64
    }
}
  3. Categorías
    GET /categories

    Método responsable por devolver las categorías de NPS.

    Ejemplo de llamada: 
                                    https://tracksale.co/live/9fcd63043104b23d81dd0334df6772f8/categories?start=01/01/2016&end=31/01/2016

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    start Date No Fecha inicial en el formato dd/mm/aaaa
    end Date No Fecha final en el formato dd/mm/aaaa


    Ejemplo de retorno

    : 
    [
    {
        "name": "Produto",
        "total": 25,
        "color": "#F8D347"
    },
    {
        "name": "Entrega",
        "total": 66,
        "color": "#5DC96C"
    }
]
  4. Status
    GET /status

    Método responsable por devolver el estado del NPS.

    Ejemplo de llamada: 
                                    https://tracksale.co/live/9fcd63043104b23d81dd0334df6772f8/status?start=01/01/2016&end=31/01/2016

    Parámetros



    Parámetro Tipo Obligatorio Descripción
    start Date No Fecha inicial en el formato dd/mm/aaaa
    end Date No Fecha final en el formato dd/mm/aaaa


    Ejemplo de retorno

    : 
    [
    {
        "name": "Pendente Cliente",
        "total": 25,
        "color": "#F8D347"
    },
    {
        "name": "Pendente Empresa",
        "total": 66,
        "color": "#5DC96C"
    },
    {
        "name": "Resolvido",
        "total": 66,
        "color": "#777777"
    }
]