Neste artigo, vamos aprender como integrar diferentes sistemas à Buk, de forma automática, para que você possa ter as informações dos seus colaboradores nesses sistemas.
Antes de começar, o que é uma API?
Uma API (Application Programming Interface), em português, significa interface de programação de aplicações. É um conjunto de métodos ou procedimentos que um software oferece para que possa ser utilizado por outro software como uma camada de abstração.
Em outras palavras, uma API explica e permite que sistemas interajam entre si diretamente e de forma simples.
A Buk possui alguma API disponível?
Fazer parte de um ecossistema de softwares é algo importante para a Buk e incentivamos a integração entre sistemas. Por isso, temos uma API completa, para que outros sistemas possam tanto ler nossas informações quanto nos enviar diretamente informações deles.
O que faz uma API em Buk?
Elas permitem exportar informações da Buk para as APIs configuradas, facilitando a transferência de informações.
Como posso acessar a API da Buk?
Após ter confirmado a integração com os sistemas partners, siga os seguintes passos:
Para acessar, primeiro você deve:
Gerar um token de acesso. Isso pode ser feito em:
Administração >> Acessos API >> Criar API Key
Clique em "Criar API Key" para poder gerar um token.
Ao criá-lo, você deve selecionar se deseja que o sistema externo possa ler informações sensíveis do colaborador (como salário). Recomenda-se criar um token para cada sistema que você deseja conectar à Buk.
Em seguida, clique nos campos caso deseje limitar o acesso por empresas, escolher uma empresa ou todas.
Com relação aos acessos à plataforma, existem diferentes permissões como:
Leitura: Com esta opção, apenas serão visualizados os colaboradores e não suas informações sensíveis.
Leitura e modificação: Com esta opção, a API poderá visualizar e modificar as informações da Buk.
Preencha os campos correspondentes conforme sua necessidade e clique em >> Atualizar API Key:
Não se esqueça que, após definir as permissões, deve clicar em “Salvar”.
Após criar a API Key, clique no ícone de olho para obter o código (Token) que deve ser registrado no servidor que você conectou com a outra API. Dessa forma será possível acessar o sistema para a integração.
Onde encontro a documentação para começar a usar a API?
Agora que você já tem seu token de acesso, deve acessar a documentação da API. A documentação é pública e pode ser acessada através do URL da empresa seguida de /apidocs. Por exemplo, se sua empresa se chama Projeto Brasil, o URL seria https:/projetobrasil.buk.com.br/apidocs. Selecionar país Brasil.
Uma vez dentro da documentação, você pode testar a API ao vivo autenticando-se por meio do botão Authorize.
Posteriormente, você poderá ver todos os “Endpoints” ou métodos que pode utilizar em nosso sistema. Para isso, clique no botão “Mostrar/Ocultar” >> “Listar”.
Por último, para testar ao vivo, clique em um dos “Endpoints” e clicar em “Teste agora (Pruébalo!)”, o sistema responderá com as informações solicitadas no formato.
Aqui, você pode acessar a Documentação da API
A partir de agora, você poderá utilizar nossas APIs e assim ter todos os seus sistemas conectados e sincronizados de forma automática.
Lembre-se, se precisar de ajuda, entre em contato conosco por meio dos nossos canais de atendimento.
Chat | Telefone | E-mail.
Ficaremos felizes em ajudar!
