Frequently Asked Questions (FAQ)

Got a question? We’re here to answer! If you don’t see your question here and won’t find an answer in our manuals either, send an e-mail to api@merit.ee using a reference “Merit Palk API”.

WHERE’S THE SANDBOX?!

We don’t have a sandbox.
Just create a user (if you don’t have it already) and then create a test company in Merit Palk. Companies up to 2 employees can use our program with PRO functionality for free.

HOW TO START?

Just take Node.js example. Put your API ID and Key in. Play with different payloads. You’ll get this.

If you need and want, we can offer you a Merit Palk tutorial to get better acquainted with the program logic and with the basic payroll rules. Contact us api@merit.ee for more information using a reference “Merit Palk API”. 

API ID AND KEY?

Yes. Log into Merit Palk and go to Settings > API Settings. Create an API Key. Use that key. Once your integration is working, you can create API credentials in the live database and start using those.

API ID and API Key are unique for every company and for every API connection. You should keep your API ID and Key secret and guard them as you would your regular account passwords. If you feel your ID and Key have been compromised, you can reset them and generate a new API ID and Key.

REQUEST PARAMETERS?

For every API request you make, you’ll need to include ApiID, timestamp and signature as request parameters. Signature is in Base64 format and is calculated using your ApiKey with HMAC-SHA-256, based on the ApiID+timestamp+RequestJSON.

REQUEST LIMITS?

There is no limit on the number of API requests per day. However, requests will be rate-limited if too many calls are made within a short period of time. Additionally, a maximum of 100 results will be returned for growing list methods.

GET OR POST?

All Merit Palk API requests are composed of JSON and delivered as an HTTP POST request to the endpoint URL.

IS THE SERVICE RUNNING?

Yes. Merit Palk has ~ 20 successful integrators. Every day we receive many requests. It’s online and running. 

ERROR 400

The data sent to the API is not appropriate. Message tag will give you more info about what went wrong.

ERROR 401

Two possible reasons:
(1) Whether API ID or the signature was incorrect;
(2) Merit Palk user do not have a PRO license.

It could also be that someone has meanwhile changed the API ID and API Key for security reasons thus making the “old” IDs and Keys obsolete.

ERROR 404

Two possible reasons:
(1) The URL is invalid;
(2) You’re missing one of the required parameters.

URL has to be like this: “https://Palk.merit.ee/api/v1/” + endpoint + “?ApiId=” + APIID + “&timestamp=” + TIMESTAMP + “&signature=” + APIKEY

HOW DO I KNOW IF THE REQUEST WAS SUCCESSFUL?

A successful response is represented as JSON with response code 200. In many cases, when needed and possible, a response will also include details of fulfilled requests.

ARE THERE ANY COSTS ADDED FOR API?

No extra fees are added for using API today, but you do need the Merit Palk PRO package. For testing purposes companies up to 2 employees can use our program with PRO functionality for free.

HOW TO CREATE SALARY AND WITHHOLDING TYPES IN MERIT PALK?

First, you need to add suitable salary types to Merit Palk (Payroll > Salary types). You have an option of “Import ID” in the salary type details. This number must match with “Typecode”. If the typecode is negative, it means this is withholding, and for that, you need to add withholding types to Merit Palk (Withholdings > Withholding types).

DO YOU SUPPORT EVENT-BASED TRIGGERS?

No, we do not support event-based triggers.

HOW DO I KNOW IF SOMETHING CHANGES IN API MANUALS?

All changes that we have made and will make, will be added to our list of changes page.