Integração On The Go

Última Atualização: 18/11/2025

Versão: 1.5

Histórico da Revisão

Data Versão Descrição Autor
19/11/2021 1.0 Criação do Documento Dirceu Belém
26/11/2021 1.1 Adicionando Print do site JWT.IO Dirceu Belém
26/11/2021 1.2 Detalhamento da geração do Token JWT Dirceu Belém
27/01/2022 1.3 Adicionando métodos:
- Folhas de Resposta da Pesquisa
- Lista de Perguntas e Respostas
- Lista Paginada de Perguntas e Respostas por Data 		João Segolin
21/08/2024 1.4 Adicionando ID da Opção nas respostas do cliente Dirceu Belém
18/11/2025 1.5 Retornando Tipo de Final da Pesquisa filtrando por filterout ou complete.
Atualizando versão da Autenticação do Usuário. 		Dirceu Belém

1. Objetivo

Este documento tem o objetivo de detalhar o processo de integração com a API On The Go.

2. Requisitos não-funcionais e Restrições técnicas

  • Protocolo de Comunicação: será disponibilizado como um WebService padrão REST/JSON.

3. Ambientes

3.1 Produção

URL base: https://apidata.onthego.com.br/v1/

4. Autenticação

O serviço abaixo realiza a autenticação na API On The Go e retorna um token JWT que deverá ser enviado no header das requisições subsequentes.

Endpoint

URL: /auth

Método: POST

Header: Content-Type: application/json

Exemplo de Request

POST /v1/auth
Content-Type: application/json; charset=utf-8
Host: apidata.onthego.com.br
Connection: close
Content-Length: 61

{"username":"usuario@usuario.com","password":"senha"}

Exemplo de Response

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Content-Length: 436
Date: Tue, 18 Nov 2025 20:34:04 GMT
Connection: close

{
  "token": "eyJhbGciOiJIUzUxMiJ9.eyJ1c2VyIjoiZWMwY2UwYzM2ZTUyODMwZjQ3NTgwOCIsInJvbGUiOiJ2aWV3ZXIiLCJuYW1lIjoiRGlyY2V1IEJlbGVtIEFQSSIsImdlbmVyaWNVc2VyIjpmYWxzZSwicmVtZW1iZXIiOmZhbHNlLCJlbWFpbCI6ImRpcmNldSthcGlAb250aGVnby5jb20uYnIiLCJwZXJtaXNzaW9ucyI6WyJhY2Nlc3NfYXBpIl0sImdob3N0IjpmYWxzZSwiZGF0YSI6IjE5LzExLzIwMjUgMTc6MzQ6MDMiLCJleHAiOjE3NjM1ODQ0NDN9.7_AhaN7Ub2DFaEMpWyM642xGwnwbq4YDdf_mnwe-wfOYUevWJG_qivbAZ_0eSZm6xV08iFOhjUobDmHb572EBA"
}

5. Lista de Pesquisas

O serviço abaixo retorna a lista de pesquisas associadas ao usuário autenticado.

Endpoint

URL: /research

Método: GET

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

GET /v1/research
token: TOKEN_DE_AUTENTICACAO
Host: apidata.onthego.com.br
Connection: close

Exemplo de Response

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Content-Length: 237
Connection: close

[
  {
    "brands": [
      "MARCA1",
      "MARCA2"
    ],
    "name": "PESQUISA 1",
    "id": 3343
  },
  {
    "brands": [
      "MARCA1"
    ],
    "name": "PESQUISA 2",
    "id": 3344
  },
  {
    "brands": [
      "MARCA1"
    ]
  }
]

6. Lista de Perguntas da Pesquisa

O serviço abaixo retorna a lista de perguntas de uma determinada pesquisa.

Endpoint

URL: /research/{ID DA PESQUISA}/questions

Método: GET

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

GET /v1/research/ID DA PESQUISA/questions
token: TOKEN_DE_AUTENTICACAO
Host: apidata.onthego.com.br
Connection: close

Exemplo de Response

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Content-Length: 1830
Connection: close

[
  {
    "idQuestionType": "9",
    "question": "Aceite Termos 1",
    "validationType": "alternativas-longas",
    "options": [
      {
        "index": 1,
        "id": "5ruodrsu5g3u01fk7tfs0o",
        "option": "Sim, concordo"
      },
      {
        "index": 2,
        "id": "6kk71c6jsve2q1fk7tfs0s",
        "option": "Não concordo"
      }
    ],
    "id": "57av4qqp8n9181fk7tfrop"
  },
  {
    "idQuestionType": "9",
    "question": "Aceite Termos 2",
    "validationType": "alternativas-longas",
    "options": [
      {
        "index": 1,
        "id": "641tde5ruhg4r1fk7tjb6q",
        "option": "Sim, concordo"
      },
      {
        "index": 2,
        "id": "7af4rg37jmjde1fk7tjb6u",
        "option": "Não concordo"
      }
    ],
    "id": "7od5bgkv593bk1fk7tjaut"
  },
  {
    "idQuestionType": "4",
    "question": "NOME",
    "validationType": "texto-aberto",
    "id": "5g8jqmfvn7no91fk7tk3l8"
  },
  {
    "idQuestionType": "4",
    "question": "EMAIL",
    "validationType": "email",
    "id": "5i8ntgjncc5411fk7tkt0l"
  },
  {
    "idQuestionType": "4",
    "question": "CPF",
    "validationType": "cpf",
    "id": "6in2epjf6ou8c1fk7tlmg3"
  },
  {
    "idQuestionType": "9",
    "question": "MAIORIDADE",
    "validationType": "alternativas-longas",
    "options": [
      {
        "index": 1,
        "id": "67ess8dupskcl1fk7tmrqc",
        "option": "SIM"
      },
      {
        "index": 2,
        "id": "6titkspneq08m1fk7tmrqg",
        "option": "NÃO"
      }
    ],
    "id": "4hi2857jrrr1s1fk7tmri5"
  },
  {
    "idQuestionType": "2",
    "question": "NPS Produto 1",
    "validationType": "nps",
    "options": [
      {
        "index": 0,
        "id": "6te28j0cpsusu1fk7to9qn",
        "option": "0"
      },
      {
        "index": 1,
        "id": "4pfrtfn2enhjq1fk7to9s7",
        "option": "1"
      },
      {
        "index": 2,
        "id": "7s1l683ro5e091fk7to9sm",
        "option": "2"
      },
      {
        "index": 3,
        "id": "4b2db5332n4e51fk7to9sq",
        "option": "3"
      },
      {
        "index": 4,
        "id": "56727qqeths3s1fk7to9te",
        "option": "4"
      },
      {
        "index": 5,
        "id": "42c7ckm02v7ns1fk7to9tm",
        "option": "5"
      },
      {
        "index": 6,
        "id": "4lh7gb4th5hsa1fk7to9u2",
        "option": "6"
      },
      {
        "index": 7,
        "id": "7t7djbeg0tnu81fk7to9ue",
        "option": "7"
      },
      {
        "index": 8,
        "id": "5s25b4avsetnq1fk7to9um",
        "option": "8"
      },
      {
        "index": 9,
        "id": "60fe3e1ecml621fk7to9uq",
        "option": "9"
      },
      {
        "index": 10,
        "id": "4r4fcgbte99me1fk7to9v2",
        "option": "10"
      }
    ],
    "id": "7mc23guq350vt1fk7to9or"
  }
]

7. Lista de Tipos de Pergunta

O serviço abaixo retorna a lista de tipos de perguntas/validações disponíveis na plataforma.

Endpoint

URL: /validationtype

Método: GET

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

GET /v1/validationtype
token: TOKEN_DE_AUTENTICACAO
Host: apidata.onthego.com.br
Connection: close

Exemplo de Response

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Content-Length: 1352
Connection: close

[
  { "idQuestionType": 6,  "validationType": "alternativas-curtas" },
  { "idQuestionType": 6,  "validationType": "alternativas-curtas-horiz" },
  { "idQuestionType": 9,  "validationType": "alternativas-longas" },
  { "idQuestionType": 4,  "validationType": "celular" },
  { "idQuestionType": 4,  "validationType": "cpf" },
  { "idQuestionType": 4,  "validationType": "datas-completas" },
  { "idQuestionType": 4,  "validationType": "email" },
  { "idQuestionType": 2,  "validationType": "escala-emoji" },
  { "idQuestionType": 2,  "validationType": "escala-emoji-na" },
  { "idQuestionType": 2,  "validationType": "escala-estrela" },
  { "idQuestionType": 2,  "validationType": "escala-numerica110" },
  { "idQuestionType": 2,  "validationType": "escala-numerica14" },
  { "idQuestionType": 2,  "validationType": "escala-numerica15" },
  { "idQuestionType": 2,  "validationType": "escala-numerica17" },
  { "idQuestionType": 2,  "validationType": "escala-numerica19" },
  { "idQuestionType": 15, "validationType": "matriz-avaliacao" },
  { "idQuestionType": 19, "validationType": "mosaico" },
  { "idQuestionType": 2,  "validationType": "nps" },
  { "idQuestionType": 4,  "validationType": "tarefa-audio" },
  { "idQuestionType": 4,  "validationType": "tarefa-imagem" },
  { "idQuestionType": 4,  "validationType": "tarefa-video" },
  { "idQuestionType": 14, "validationType": "test-ab" },
  { "idQuestionType": 13, "validationType": "teste-multipla-escolha" },
  { "idQuestionType": 13, "validationType": "teste-ranking" },
  { "idQuestionType": 4,  "validationType": "texto-aberto" }
]

8. Folhas de Resposta da Pesquisa

O serviço abaixo retorna as folhas de resposta da pesquisa. Podem ser filtradas por tipo de finalização (complete ou filterout).

Endpoint

URL (complete): /research/{ID DA PESQUISA}/answersresearch/complete

URL (filterout): /research/{ID DA PESQUISA}/answersresearch/filterout

URL (genérico): /research/{ID DA PESQUISA}/answersresearch

Método: GET

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

POST /v1/research/ID DA PESQUISA/answersresearch
token: TOKEN_DE_AUTENTICACAO
Host: apidata.onthego.com.br
Connection: close

{
  "startDate": "2021-01-01T00:00:00",
  "endDate": "2023-01-01T00:00:00",
  "page": 1,
  "registers": 1000
}

Exemplo de Response

HTTP/1.1 200
Content-Type: application/json;charset=utf-8
Connection: close

{
    "totalRegisters":3,
    "registers":1000,
    "page":1,
    "list":[
        {"date":"2022-10-16 11:42:02.821","lastType":"CO","id":"5ritt9i5t7kbq1fp01afpt"},
        {"date":"2022-11-10 10:29:23.266","lastType":"CO","id":"42qqkuk11g2o61fovftvas"},
        {"date":"2022-10-20 10:15:04.618","lastType":"CO","id":"6eedt78mlqtgn1forh1020"}
    ]
}

9. Lista de Perguntas e Respostas

O serviço abaixo retorna a lista de perguntas e respostas de um respondente específico em uma pesquisa.

Endpoint

URL: /research/{ID DA PESQUISA}/{ID DA FOLHA DE RESPOSTA}

Método: GET

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

GET /v1/research/ID DA PESQUISA/ID DA FOLHA DE RESPOSTA
token: TOKEN_DE_AUTENTICACAO
Host: apidata.onthego.com.br
Connection: close

Exemplo de Response

[
  {
    "date": "2022-01-09 11:20:54.734",
    "question": "Você se lembra de ter visto alguma propaganda ou comunicação sobre o Natal na TV, internet ou nas redes sociais?",
    "answer": "Não lembro",
    "idQuestion": "5qdgpofv9rlh01fonlej0g"
  },
  {
    "date": "2022-01-09 11:21:25.967",
    "question": "Sobre o vídeo - Você lembra de ter visto essa propaganda?",
    "answer": "Não me lembro... 😅",
    "idQuestion": "476epuffv8nbh1fonncsbj"
  },
  {
    "date": "2022-01-09 11:21:42.039",
    "question": "Sobre o vídeo - O quanto você gostou da propaganda?",
    "answer": "Gostei, mas não chega a me motivar a ir à loja",
    "idQuestion": "5f51apqcvup3s1fonnjvv3"
  },
  {
    "date": "2022-01-09 11:22:08.44",
    "question": "Sobre o vídeo - O que você mais gostou nessa propaganda?",
    "answer": "O carinho",
    "idQuestion": "6q67eoms1lvjc1fooi61ao"
  },
  {
    "date": "2022-01-09 11:22:25.156",
    "question": "Sobre o vídeo - O que você menos gostou nessa propaganda?",
    "answer": "Gostei dela",
    "idQuestion": "5nsqoum7up67m1fonnlqkh"
  },
  {
    "date": "2022-01-09 11:22:46.456",
    "question": "Sobre imagens - Você achou clara e fácil de entender a comunicação acima?",
    "answer": "Sim, achei! 😊",
    "idQuestion": "4lkvoe4pgiumm1fono1mc2"
  }
]

10. Lista Paginada de Perguntas e Respostas por Data

O serviço abaixo retorna uma lista paginada de perguntas e respostas de todos os respondentes da pesquisa, filtrada por intervalo de datas. O limite máximo é de 1000 registros por requisição.

Endpoint

URL: /research/{ID DA PESQUISA}/answersbydate

Método: POST

Header:
token: TOKEN_DE_AUTENTICACAO

Exemplo de Request

POST /v1/research/ID DA PESQUISA/answersbydate
Content-Type: application/json; charset=utf-8
Host: apidata.onthego.com.br

{
  "startDate": "2021-01-01T00:00:00",
  "endDate": "2023-01-01T00:00:00",
  "page": 1,
  "registers": 1000
}

Exemplo de Response

{
  "totalRegisters": 7969,
  "registers": 1000,
  "page": 1,
  "list": [
    {
      "date": "2022-01-07 21:26:29.949",
      "idResearchAnswer": "40dq13nia6uej1fordok40",
      "question": "Você se lembra de ter visto alguma propaganda ou comunicação sobre o Natal na TV, internet ou nas redes sociais?",
      "answer": "Não lembro",
      "idQuestion": "5qdgpofv9rlh01fonlej0g"
    },
    {
      "date": "2022-01-07 21:27:02.195",
      "idResearchAnswer": "40dq13nia6uej1fordok40",
      "question": "Sobre o vídeo - Você lembra de ter visto essa propaganda?",
      "answer": "Não me lembro... 😅",
      "idQuestion": "476epuffv8nbh1fonncsbj"
    },
    {
      "date": "2022-01-07 21:28:24.506",
      "idResearchAnswer": "40dq13nia6uej1fordok40",
      "question": "Sobre o vídeo - O quanto você gostou da propaganda?",
      "answer": "Gostei e me motivou",
      "idQuestion": "5f51apqcvup3s1fonnjvv3"
    },
    {
      "date": "2022-01-07 21:29:44.795",
      "idResearchAnswer": "40dq13nia6uej1fordok40",
      "question": "Sobre o vídeo - O que você mais gostou nessa propaganda?",
      "answer": "Que mostra a simpatia dos funcionários",
      "idQuestion": "6q67eoms1lvjc1fooi61ao"
    }
  ]
}