Skip to main content

Create Application

To call the Mekari POS API, you need an application on the Mekari Developer portal. The application gives you the client credentials for HMAC authentication.

info

Use developers.mekari.com for production and sandbox-developers.mekari.com for the sandbox.

Request Access​

Before you begin, confirm that your account is authorized to access Mekari Developer.

  1. Go to developers.mekari.com and log in with your Mekari account.
  2. If your dashboard displays an empty page, your account has not been authorized.
  3. Contact your specialist or support to request Mekari Developer access.

Create an Application​

Once you have access to the Mekari Developer dashboard, follow these steps to create an application:

  1. Click the Create Application button near the top of the dashboard.
  2. Fill in the required fields:
FieldDescription
Application NameA descriptive name that reflects your integration purpose (e.g., ERP Sync Internal).
CompanyThe merchant company you want to integrate with. You can select only one company per application; to integrate with more companies, create one application per company. The company's Mekari POS plan must include the Public API add-on.
Authorized ScopesThe endpoints your application may call. Open the mekari-pos-open tab and select scopes that start with mekari-pos-open:v2:. Select only the scopes your application needs (see Scopes).

Create application - form

  1. Click Submit to create the application and generate your client credentials.
tip

Only request the scopes your application actually needs. This follows the principle of least privilege and limits the impact if credentials are compromised.

Scopes​

Every Mekari POS endpoint has its own scope. All Mekari POS scopes start with mekari-pos-open:v2:.

ScopeGrants
mekari-pos-open:v2:allEvery endpoint of API v2
mekari-pos-open:v2:<resource>:allEvery endpoint of one resource, for example mekari-pos-open:v2:customer:all
mekari-pos-open:v2:<resource>:<action>One endpoint, for example mekari-pos-open:v2:customer:list for GET /customers

Resources: outlet, user, shift, customer, promotion, voucher, category, collection, product, raw-material, recipe, inventory, order-source, payment-method, order, return, refund, exchange, approval, webhook.

A request to an endpoint outside your application's scopes is rejected by Mekari API Gateway with 401.

Client Credentials​

After you submit the application form, the portal displays your Client ID and Client Secret.

Create application - credentials

danger

Copy the Client Secret immediately. The secret is only displayed once and cannot be retrieved later. If you lose it, you must regenerate new credentials.

CredentialDescription
Client IDIdentifies your application; used as username in the HMAC header
Client SecretUsed to sign your requests. Keep this confidential.

Use these credentials to generate HMAC signatures for authenticating your API requests. See HMAC Authentication for implementation details and code examples.

Next Steps​