Return to site

How to use BizMerlinHR API Documentation

September 17, 2021 ·

Introduction

BizMerlin APIs provide robust integration options to interact with the data, in much the same way as the web application.  You can get their API keys from the BizMerlin portal and start using the services immediately.  The calls follow the RESTful architecture and naming, and are secured via https, just like calls from the web browsers.

The API key has the same security access as the user to whom the key belongs.

Obtaining your API key and User ID

BizMerlin APIs accept an API key via HTTP request Authorization Header. Each user can get Authorization API key (also called x-api-key)  from within the application using these steps:

    1. Hover over your user record in the top right corner and click on My Integrations.
    2. In the My Integration page switch to Manage API Keys and then click on Generate API keys button.

    3. When you click on the Generate API key button a new section will appear carrying the API key. You can copy the key after click on the “show” link.

You can grab your User ID from the same Integration screen

Try out an API endpoint

When you visit https://bizmerlinhr.readme.io/reference/   you will see various API endpoints on the left panel of the page.

You can navigate to any of these endpoint and test it out by inserting API Key and UserID and other necessary values required to get response from that API

For e.g : To get the skills list navigate to the skills link from left panel and fill the User Id and API Key which you retrieved from your application

After fill the API key and User ID hit the [Try It!] Button and you will receive the response from that API (like shown in below screenshot).

You can try more endpoints in the same way…