In this article, we will learn how to automatically integrate different systems with Buk so you can have your employees' information available through these systems.
Before Getting StartedWhat is an API?
An API (Application Programming Interface) is a set of methods or procedures offered by a software so that it can be used by another software as an abstraction layer.
In other words, an API explains and allows systems to interact with each other directly and easily.
Does Buk have an available API?
At Buk, we like to be part of the software ecosystem and encourage integration between systems. Therefore, we have a complete API so that other systems can both read from us and feed us directly with their information.
What does an API do in Buk?
APIs allow you to export information from Buk to the configured APIs, making it easier to transfer information.
How can I access the Buk API?
After confirming the integration with the Partner systems, you must follow these steps:
To access, you must first:
Generate an access token. You can get this at:
Settings >> API Access >> Create new API Key
Click on create new API Key to generate a token
When creating it, you must select if you want the external system to be able to read sensitive employee data (such as salary). It is recommended to create one token for each system you want to connect to Buk..
Then, you must click on the boxes if you want to limit access by company, select one company or all.
Regarding platform access, there are different permissions such as:
Read: With this option, you will only see employees and not their sensitive information.
Read and modify:Withthis option, the API will be able to view and modify information in Buk.
You must fill in the corresponding fields according to your needs. Then, you must click on>> Update API Key:
Don’t forget that after setting the permissions, you need to click on“Save”
After creating the API Key, you must click on the icon“Eye”to obtain the code (Token), which must be registered on the server you have connected with the other API. This way, you will be able to access their system for integration.
Where can I find the documentation to start using the API?
Now that you have your access token, you need to go to the API documentation. The documentation is public and you can access it through your company’s URL followed by /apidocs. For example, if your company is called Proyecto Perú, the URL would be https:/proyectoperu.buk.pe/apidocs. Select country Peru.
Once in the documentation, you can test the API live by authenticating through the Authorize button.
Afterwards, you will be able to see all the“Endpoints”or methods that you can use in our system. You must click on the button“Show/Hide”>>“List”.
Finally, to test live, you can click on one of the“Endpoints” and by clicking on“Try it out!”, the system will respond with the requested information in the format.
Here, you can access the API Documentation
From now on, you will be able to use our APIs and have all your systems connected and synchronized automatically.
Remember, if you need help you can contact us through our support channels.
Chat | Phone | Email.
We’re happy to help!
