Getting Started

A Practical Guide to Get You Up and Running With the Markaaz API Services.

If you haven't already requested your API Key sign up now, Request API Key. You will be provided access to retrieve your trial API Key (x-api-key) and a Partner Id (x-partner-id). Make a note of these items but keep them secure just like you would with any access token. Once we have a signed contract, you will be converted to an account with full production access in addition to sandbox access, your authentication credentials will change.

📘

Retrieve your API Key and Partner ID by logging into the Enterprise Partner Portal and navigate to Settings -> System Level Settings -> Authentication & Endpoint Details. There are separate credentials for Sandbox and Production. Trial user accounts only have access to the Sandbox environment and are throttled to 100 API calls.

Using Your API Key

Upon clicking into the API Reference section for a specific endpoint, you will see a section similar to this where you'll enter the x-api-key value into the Header field. You do not need to edit the Base URL. You may also choose a programming language you wish to implement. CURL is a command line call and that is possibly the easiest to test but can also be used in other ways.

Entering Your Partner ID

In addition to the Header field located in the Authentication section shown above, there is a "HEADERS" block in the center of the API Reference page where you will enter your Partner Id (x-partner-id) as shown below.