Elmatajer · API docs
Getting started

App install link

Building an app for many stores? Don't ask each merchant to copy a key. Send them to an install link: they sign in, see exactly what your app asks for, approve — and we POST a key for their store to your server.

Build the link

https://elmatajer.com/install-app
  ?app_name=YOUR_APP_NAME
  &app_description=WHAT_IT_DOES
  &app_icon=https://your-app.com/icon.png
  &permissions=orders.read,webhooks
  &callback_url=https://your-app.com/elmatajer/callback
  &webhook_url=https://your-app.com/elmatajer/webhook
  &redirect_url=https://your-app.com/connected
Parameter Required Description
app_name Yes Your app's name, shown on the consent screen.
callback_url Yes Server URL (https) that receives the key — see below.
permissions Yes Comma-separated permissions.
app_description No One line on what your app does.
app_icon No Square image URL (https).
webhook_url No Where store events are sent (Webhooks). Needs the webhooks permission.
redirect_url No Where the merchant's browser lands after approving.

After the merchant approves

We send a POST to your callback_url:

{
  "api_key": "51|o2NDtg7cT…",
  "store_id": 5907,
  "scope": "orders.read webhooks",
  "webhook_secret": "9fK…",
  "api_base": "https://elmatajer.com/api/v1/vendor"
}

Store api_key and webhook_secret per store. Then the browser goes to your redirect_url with ?status=connected&store_id=5907 (status=denied if the merchant refused).

First connection is reviewed

The first time your app is installed, Elmatajer reviews it. After approval, every store can install it instantly. The merchant can revoke your access any time from Connected apps.

Prefer standard OAuth 2.0? See OAuth.