Passar para o conteúdo principal
Todas as coleçõesAPI da Elofy
Como utilizar a API aberta da Elofy?
Como utilizar a API aberta da Elofy?

Quer conectar a Elofy com outros sistemas utilizados pela sua empresa? Veja aqui:

Atualizado há mais de um ano

🙋 Acessar os dados da API aberta da Elofy está disponível apenas para o perfil administrador, para saber mais clique aqui.

A API aberta da Elofy permite que a plataforma se conecte de forma integrada com outros sistemas utilizados pela sua empresa como ferramentas de BI, por exemplo.

Isso significa mais automação, acesso em tempo real a dados e a possibilidade de personalizar processos, como a sincronização de metas, geração de relatórios e atualizações de usuários.

Veja abaixo como simplificar e expandir suas operações com a Elofy conectada ao seu ecossistema digital:

Utilização da API aberta

Esta primeira parte é válida para todos os tipos de ferramenta de BI. Acesso o link das API's de dados:

Dentro da API de dados, faça o login com o seu login e senha de acesso do Elofy ou utilize seu token de usuário (caso você utilize a plataforma por Google ou Microsoft).

Com login e senha de acesso do Elofy

Passo 01

Selecione a aba de login:

Passo 02

Clique em "Try it out" e coloque o seu e-mail e senha de acesso do Elofy, dentro das aspas:

Passo 03

Clique em "Execute":

Passo 04

E, novamente, clique em "Execute":

Passo 05

Ao executar, desça a tela e copie o token sem as aspas:

Passo 06

Suba a tela novamente e clique em "Authorize":

Passo 07

Cole o token em "value" e depois clique em "authorize". Depois feche em "close":

Passo 08

Dentro da API desejada, clique em "Try it out" e em "Execute" e, novamente, em "Execute":

🚨 Para a API de Plano de Desenvolvimento Individual é preciso inserir a data inicial e final do período antes de clicar em execute.

Algumas API's precisam do ID do período/janela para que possam funcionar. São elas:

  • Objetivos e Resultados-chaves

  • Revisão do ciclo:

    • Status das avaliações

    • Médias finais e notas por fase

    • Notas por avaliador

    • Médias - fase por resultados

    • Médias - fase por competências

    • Nbox

    • Público

O ID do período é coletado na API de períodos. Por isso, primeiro execute a API de períodos para voltar na API desejada e inserir o número do ID:

Dentro da API com filtro obrigatório, primeiro clique em "Try Out", em seguida, coloque o ID do período no seguinte campo:

Por fim, clique em "execute" e, novamente, em "execute".

Passo 09

Verifique os dados na parte de Responses:

Caso o processo não tenha dado certo, o sistema irá acusar error:


Com seu token de usuário

Passo 01 - Acesso

Acesse Configurações > Funcionalidades > Geral > Integrações e API:

No fim da tela, colete o seu token na opção Token API Pública - Dados dos módulos.

Passo 02 - Link de API

Volte no link de API e dentro da API desejada, clique no ícone de cadeado.

Passo 03 - Cole o token

Cole o seu token do Elofy em "value" e depois clique em "authorize". Depois feche em "close":

Depois na mesma API, clique em "Try it out" e em "Execute" e novamente em "Execute":

🚨 Para a API de Plano de Desenvolvimento Individual é preciso inserir a data inicial e final do período antes de clicar em execute.

Algumas API's precisam do ID do período/janela para que possam funcionar. São elas:

  • Objetivos e Resultados-chaves

  • Revisão do ciclo:

    • Status das avaliações

    • Médias finais e notas por fase

    • Notas por avaliador

    • Médias - fase por resultados

    • Médias - fase por competências

    • Nbox

    • Público

O ID do período é coletado na API de períodos. Por isso, primeiro execute a API de períodos para voltar na API desejada e inserir o número do ID.

Dentro da API com filtro obrigatório, primeiro clique em "Try Out", em seguida, coloque o ID do período no seguinte campo:

Por fim, clique em "execute" e, novamente, em "execute".

Passo 05 - Verificação em Responses

Verifique os dados na parte de Responses:

Caso o processo não tenha dado certo, o sistema irá acusar error:


Pronto. Agora você já sabe como utilizar a API aberta da Elofy.

O que achou do artigo? Clique no emoji que mais representa sua opinião ⬇️

Respondeu à sua pergunta?