Detailed information available at https://bizmerlinhr.readme.io

Introduction

ClayHR 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 ClayHR 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

ClayHR 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

Here is a quick list of steps for accessing the ClayHR API services:

1. (Optional) Install Postman application.  You can use other clients.  Postman is just one handy option and also shows you the code to use in your actual programming stack.  Download and Install the latest stable version of Postman API for your OS from https://www.getpostman.com/
2. Each user will get an UserId and a domain url (URL specified by ClayHR) from User Profile page.
3. Each user can get Authorization API key (also called x-API-key)  from User Profile, scroll down to My Integration and then to Manage API keys and finally on Generate API key.
   a. The authorization to access the API is by using the x-API-Key through the HTTP header.
   b. ClayHR API key:
   

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).
   a. Specify URL in Postman API:
   

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

5. Endpoint user will send a HTTP request with HTTP header contains API key for key Authorization and application/json value for key Content-Type.
   a. Example: (key-value pair)
        a) Authorization: {“x-api-key”: “8W8ZRE4CNXMRST8XXXXX”}
       b) Content-Type: application/json
       c) userid:112XXX
    b. HTTP Header:
   

‍

‍