Return to site

How to interact with BizMerlin APIs

May 10, 2019 · BizMerlin APIs,

Introduction

BizMerlin APIs provide robust integration options to interact with the data, in much the same way as the web application.  Users 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.

Design

BizMerlin APIs accept an API key via HTTP request Authorization Header. Each user can get Authorization API key (also called x-API-key)  from User Profile.  Scroll down to My Integration and then click on Manage API keys option.  Click on Generate API key as shown in the screenshot below. Also, you will need the UserId from the URL of the User Profile page as shown in the screenshot below.

Requirements

For accessing the BizMerlin API services, Customer needs to go through following steps:

  1. Get an API key, user ID and domain url (URL specified by BizMerlin) from User Profile page.

  2. Each end point user will send an access token via HTTP header.

  3. From request end-point, user belonging to a particular customer domain will send a HTTPS request (POST/GET/PUT/DELETE) to a specified url (provided upon procuring an API).

  4. Endpoint user will send a HTTP request with HTTP header contains access token for key Authorization and application/json value for key Content-Type.

Example

To get Goals list

URL – https://yourcompany.BizMerlin.net/rm/goal/

Request type – GET

HTTP Header – Authorization:{“userId” : 123, “apiKey”: “czMDRkMjBjOWY0MkjlXg2s23g13X”}

Content-Type: application/json