Skip to main content
At the end of this page your backend has sent an email for a test restaurant, and your app shows that restaurant its send history in a Minimo widget. You need a backend that can make HTTPS calls and a web page you control. No template is needed to start. Replace YOUR_MINIMO_KEY with your key, and use a test inbox you own as the guest address.
1

Create an API key

In app.minimo.it open Developer → API keys and press Create new API key. The dialog starts with Subscribe, Transactional, Stats, Webhook and Goals already selected. Keep Transactional and remove the others. Then open the list and add Widgets and Events. Add Domains only if your backend will add domains or senders through the API. You can also verify your domain in the dashboard. Copy the key (mn-…): it is shown once. Keep it on your server.
Until the first credit top-up in Settings → Plan & billing, your workspace sends at most 100 emails a day (UTC). That is enough for this page and for tests.
2

Turn on restaurants (do this first)

Save your widget settings. allowedOrigins are the web pages of your app that will show Minimo widgets.
From now on, each tenant you send is a separate restaurant with its own guests, consent and statistics. Before this call, tenant is only a label and all restaurants share the same guests. No page with widgets yet? Put only http://localhost:3000 and add your real origins later.Later, when you have master templates, call it again with masterTemplateIds (their uids). Each field you send replaces only that list.
3

Send the first email

Name the restaurant with tenant: a string you choose, for example your restaurant id. The restaurant is created on first use.
Your app writes the email; Minimo delivers it.
GET /public/v1/emails/7OA38FO/stats tells you later if it was opened or clicked.
Until you verify a domain of yours, the email goes out from a shared Minimo address with your workspace’s name. That is fine for tests. For real restaurants you send from your own domain: see Senders and domains.
4

Create a widget session (your backend)

When a restaurant opens the page, your backend asks Minimo for a session for that restaurant and gives only the URLs to the browser.
server/minimo-widgets.js
Expose it to your page behind your own login, for example GET /api/minimo/widgets. A session lasts 60 minutes: create a new one each time the page opens, and never share it between restaurants.
5

Show the widget in your page

The restaurant sees the email you sent in step 3. Mount urls.stats the same way for its statistics, and urls.templates for its automatic messages once you have master templates.

If a call fails

Every error body is { "status": "FAIL", "message": "<CODE>", "userMessage": "…" }. Read userMessage first: it says what to fix. The most common ones:
  • 401 INVALID_TOKEN: wrong key, or the key lacks the permission of that endpoint.
  • 400 INVALID_PARAMETERS: a field is wrong, or the widget settings of step 2 are missing.
  • 402 QUOTA_EXCEEDED: the 100 emails a day before the first top-up.
All codes: Errors and limits.

Next step

Go live: the checklist before your first real restaurant Related: Rules (let Minimo time the reminders) · All widgets · How it works