Return to site

How to Interact with BizMerlin API using Postman

May 10, 2019 ยท BizMerlin APIs,

Introduction

BizMerlin APIs provides robust solutions to the Customers. Customers can get their access token from BizMerlin portal and start using the services immediately. A secure call via RESTful framework will be established between BizMerlin and end-point customer.

Design

BizMerlin APIs accept an access token via HTTP request Authorisation Header. Customers will be provided with an access token and a unique URL by BizMerlin. Each customer will have its own users. Each user belongs to a particular customer domain will be able to access the services with an access token of itself. BizMerlin APIs will return JSON formatted Array response to the endpoint user.

Requirements

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

  1. Install Postman API
  2. Each user will get an access token and a domain url (URL specified by BizMerlin) from User Profile page.

    • User Profile:

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

    • The authorization to access the API is by using the Access token through the HTTP header.

    • BizMerlin API Access token:
  4. From request end-point, user belongs to a particular customer domain will send a HTTPS request (POST/GET/PUT/DELETE) to a specified URL (provided upon procuring an API).

    • Specify URL in Postman API:

    • Append parameters to URL in Postman API: (key-value pair)

  5. 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: (key-value pair)

      • Authorization: {“accessKey”: “ZGVtbzpiMmZkODJhOTdjM2I0MjZlOGVmODI5NjUXXXXXXXXXXXX”}

      • Content-Type: application/json
    • HTTP Header: