Baixar PDF
Conceito: API Peakon
Use a API do Peakon para recuperar dados de engajamento do Peakon. Autenticar com um token de acesso e, em seguida, fazer solicitações GET aos pontos de extremidade para acessar as pontuações de engajamento e as principais métricas.
Autenticação
Depois que um aplicativo personalizado é criado, você recebe um token de acesso gerado. Esse token é um segredo e exclusivo para seu aplicativo. Faça uma solicitação POST usando o ponto de extremidade /v1/auth/application para trocar seu token de acesso por um token de autorização.
curl --location --request POST 'https://SUDBOMAIN.peakon.com/api/v1/auth/application' \ --header 'Content-Type: application/json' \ --data-raw '{ "token": "Add your token here" }'
O corpo da resposta de uma solicitação de autenticação bem-sucedida conterá um token de autorização JWT a ser usado em todas as solicitações de API subsequentes. Observe que, mesmo que um aplicativo possa ter mais de um token de autorização, os limites de taxa são aplicados por aplicativo.
Depois de se autenticar com um token de acesso para obter um JWT, você pode usá-lo para fazer solicitações GET aos pontos de extremidade para acessar as pontuações de engajamento e outras métricas principais. Visitar Etapas: criar aplicativos personalizados com a API REST para obter mais informações sobre como configurá-lo.
Filtragem
Além das rotas contextuais, a filtragem adicional tem suporte para muitas rotas por meio do parâmetro de consulta Filter. Se uma rota oferecer suporte à filtragem, ela será listada como um parâmetro de consulta na especificação de rota abaixo. Os filtros são organizados com base em seu modelo lógico. Para filtrar pelo driver de pergunta, prefixe o filtro com
question
. Exemplo:GET /v1/engagement/drivers?filter[question.driver]=autonomy
Vários operadores têm suporte para campos correspondentes. Exemplo: para obter pontuações apenas para os motoristas autônomos e recompensados, você pode fornecer o seguinte filtro:
GET /v1/engagement/drivers?filter[question.driver]=autonomy,reward$in
Para obter uma lista de operadores de filtragem compatíveis, acesse Referência: valores de filtragem de API Peakon.
Formato JSON
Todos os objetos são renderizados usando a API JSON, um método do para modelar um gráfico de objetos usando JSON.
Roteamento
Algumas solicitações podem ser restritas a um segmento arbitrário da empresa. Você pode estar interessado em analisar os dados de engajamento de todos os subordinados diretos de um determinado gestor ou o eNPS de um determinado departamento.
Exemplo: a ID de segmento do Departamento de vendas é 149. A visão geral de engajamento para este departamento pode ser obtida pela seguinte solicitação:
GET v1/engagement/context/149/overview
Para obter a ID do segmento, use o seletor de contexto para alterar o contexto da Empresa para o próprio segmento. O seletor de contexto está localizado no canto superior esquerdo da página. Pesquise e selecione o nome do segmento para acessá-lo. A ID do segmento aparece no URL após o
segment/
parâmetro. Para obter mais informações sobre o comutador de contexto, acesse Conceito: contextos do painel.Limite de taxa
O Peakon é um serviço multilocatário. Existem limites de taxas para evitar que clientes individuais consumam uma quantidade desproporcional de recursos. Cada aplicação registrada está, por padrão, sujeita aos seguintes limites de taxa:
- Até 5.000 solicitações por hora.
- Até 12 minutos de tempo de processamento para cada 5 minutos de marcação de ponto.
Se o seu aplicativo exceder um dos limites, a API retornará um
429 Too Many Requests
resposta. Os limites de taxa por padrão são revistos e atualizados periodicamente.