Veja como gerar tokens de integração.
Uma API (Interface de programação de aplicações) é o meio pelo qual duas plataformas distintas conseguem se comunicar. Caso você tenha interesse em uma integração da Convenia com outro sistema, primeiro é importante saber se essa integração já existe através desta lista de artigos (temos um artigo para cada integração já desenvolvida). Se existir, é só seguir o tutorial específico de cada uma.
Caso constate que a integração ainda não existe, é importante que valide se o outro sistema tem uma API aberta e disponível para uso; essa é a documentação API da Convenia. Uma vez constatada a possibilidade, a integração poderá ser desenvolvida por sua equipe de TI, ou pelo sistema parceiro que você tem interesse de integrar com a Convenia, pois atualmente nosso time não trabalha nesse desenvolvimento de integrações nativas.
Ao ler nossa documentação API, você irá perceber que para fazer diversas requisições, se faz necessário o uso de um token, que funcionará como uma "chave" de segurança. Esse token é formado através da plataforma da Convenia, e você DP/RH terá a permissão para fazer seguindo o passo a passo abaixo:
CRIANDO UM TOKEN
Passo 1) Clique em sua foto de perfil (ou iniciais do seu nome) > Configurações.
Passo 2) Clique em API
Passo 3) Selecione a opção de "Adicionar novo token":
Passo 4) Crie um nome para o token:
Passo 5) Selecione as informações que podem ser obtidas ao utilizar esse Token (lembrando que elas devem ser selecionadas dentro da categoria de endpoint que está sendo usado)
Se você não tiver certeza sobre quais informações selecionar, recomendamos que entre em contato com a plataforma que deseja integrar. Assim, você poderá confirmar quais permissões são necessárias no token para garantir que a informação seja migrada corretamente e que a integração funcione de maneira eficaz.
Passo 6) Clique em "adicionar" para salvar o token, e disponibilize-o à equipe responsável.
Pronto! O token foi criado.
| Você pode acessar a documentação da nossa API por esse link: |
| https://public-api.convenia.com.br/ |
INFORMAÇÕES IMPORTANTES 📢
- Correspondências de endpoints e seleção de token: endpoint contido em "obter todos os colaboradores" = "listagem de colaboradores" na Convenia; endpoint contido em "obter um colaborador específico" = "Detalhe de colaborador" na Convenia.
- Ao selecionar a opção "Remover" o token é invalidado automaticamente.
- A cada informação que for incluída por nossa equipe de produto dentro de um endpoint, é necessária a edição e inclusão manual no token já utilizado para que essa informação seja disponibilizada.
- Para ser atualizado sobre as mudanças feitas na nossa API, assine a nossa newsletter exclusiva sobre API.
Caso tenha encontrado alguma dificuldade ou precise de mais esclarecimentos, não hesite em entrar em contato com nossa equipe de atendimento. Estamos aqui para ajudar!