Authentication, Headers, and Environments

Authentication

Authenticate with the x-partner-id and x-api-key passed in the header of each API request.

These values will be provided by Markaaz and sent to you when your account is provisioned. Keep these numbers secure.

Headers

x-partner-id: <your partner ID provioded my markaaz>
Content-Type: application/json
Accept: application/json
x-api-key: <your API key provioded my markaaz>
User-Agent: <the user agent of your requesting system>
Cache-Control: no-cache
Accept-Encoding: gzip, deflate, br
Content-Length: 515
:path: /v2.0/business/advanced-match
:method: POST
:authority: api-partner.app.markaaz.com
:scheme: https

Environments

Sandbox

The Developer Portal provides access to the sandbox environment and allows familiarization with the Markaaz API Services. Access to the APIs is managed through your Markaaz Enterprise Portal account.

The Enterprise Portal (EPP) is also used to configure and manage the set of configuration parameters used by the Markaaz API suite. The sandbox environment limits the number of API calls that a trial user can make and certain premium features in the Decisioning and Monitoring Suite are disabled.

Response data returned by the sandbox APIs comes from the production Markaaz Directory of more than 540 million global businesses. Sandbox testing responses are an accurate representation of production data. (<--check the 540M number)

Once you've been onboarded as a customer by the Markaaz team, and a commercial relationship is established, access to production will be enabled.

Production

Production APIs use the same endpoints, but the base URL is different and does not include the reference to "sandbox". For an integration, store the base URL as a variable in your code and then it's a simple process to make the change and begin accessing production. We'll also provide the production API Key and Partner ID. Just as with sandbox, the Markaaz Enterprise Portal (EPP) will be used to manage your account and configure the services provided by the Markaaz APIs.


Did this page help you?