Keys, test mode and guests

Publishable app keys and secret API keys for Tamr's SDK: test keys versus live keys, guest mode versus signed-in diners, and what the restaurant sets up for you.

You need a publishable app key for your app and, for your backend, a secret API key. Build with a test app key and switch to a live one when you go live.

What the restaurant sets up for you

Tamr switches the SDK on for the restaurant. Then an owner or admin of the restaurant's Tamr account works in Settings in the dashboard at https://tamr.link/app, or you do, if they invite you with the Developer role. A Developer sees every page below and nothing else in Settings: no menus, staff or billing.

PageWhat it holds
App keysYour publishable keys, test and live, each with its allowed website origins, its app ids (iOS bundle id, Android package name) and whether it allows guests. The diner token signing keys for each key. The webhook endpoints. A link to the host simulator.
API keysSecret API keys for your backend, each with its permissions. A Developer makes keys for the SDK only (diner sessions, catalog ids or orders) and sees only their own.
Install the SDKSetup per platform with the restaurant's address filled in, a Try it test key, the token signing samples, the methods and events with the version that added each, and Copy setup for a developer. It also shows which SDK versions your apps run and how fast the chat opens on real devices.
Waiter in your appHow the waiter looks and talks in your app, and Orders go to. Changes are drafts until the restaurant publishes them.
External idsYour ids for each dish, size and option, by hand or as a CSV file.

Ask the restaurant for its address, the branch addresses if it has several, a test app key, its "Orders go to" choice, and a secret API key with the permissions you need. A key is shown once, when it is made, so whoever makes it should pass it to you safely.

Test keys and live keys

Test key tamr_pk_test_…Live key tamr_pk_live_…
MenuThe restaurant's own menus, against productionThe same
LabelThe page shows "Test mode"None
Orders, payments, bookingsA pickup is a test order: checked and priced as a real one, never sent to the restaurant. Dine-in orders, payments and bookings are refusedReal
Limits60 requests a minute per key (30 per network address), 50 conversations a day per key600 requests a minute per key (200 per network address)
DashboardKept out of Insights and billing, hidden from Conversations unless filteredCounted
Website originshttps://…, plus http://localhost:<port> and http://127.0.0.1:<port>https://… only
WebhooksSent to test endpoints, with livemode: falseSent to live endpoints

The Try it step on Install the SDK can also make a two-hour test key for guests, filled into the code it shows.

Guests or signed-in diners

Each key either allows guests (guest mode) or not.

  • Signed-in diner, the default for live keys: your backend signs a token naming your user. The diner keeps the same conversation across their phones, gets "the usual" from their past orders, can save a nutrition goal and rate an order.
  • Guest: anyone can chat, with lower limits and no history or personalisation. Use it for apps with no login. A guest can still order and pay where the restaurant takes orders through Tamr.

On a key without guest mode, an identity provider that answers "no one" leaves the chat unable to start. On a key with guest mode, it opens a guest chat.

Secret API keys

Your backend's key, made in Settings > API keys by an owner or admin, with only the permissions it needs (diner:sdk, catalog:sdk, orders:sdk, catalog:read). It never goes in an app or a website. See Keys and permissions.

The host simulator

Settings > App keys > Host simulator opens the restaurant's waiter page as an app shows it, with its own two-hour test key. It can sign a test diner in, play the app's cart, and shows every message between the page and the app. Use it to see what your app will receive before you write code.