API keys in chain admin

With the Vendion API another system, for example your event tool, can read and create events in table booking. The system connects with an API key that you create yourselves in Vendion. A key is not tied to a person and keeps working if the person who created it leaves.

What you need

• You are active in the chain's Admin group (Kedjeöversikt → Medlemmar, Chain overview → Members). The API-nycklar (API keys) section is only shown to the Admin group.
• The restaurants the system should reach have Vendion Integration. A chain key reaches all the chain's restaurants that have Vendion Integration, including restaurants that join the chain later.

Create an API client

A client is the system that will call Vendion. Create one client per system.

1. Open Kedjeöversikt → Inställningar (Chain overview → Settings) and scroll down to the API-nycklar (API keys) section.
2. Tap Skapa API-klient (Create API client).
3. Enter the system's Namn (Name), for example "Eventverktyget" (the event tool).
4. Under Behörigheter (Permissions) choose what the system may do. All four are ticked by default. Untick what the system doesn't need.
5. Tap Skapa (Create).

You control which events the system may add occurrences of with a type code on the event, see Type code on events.

Create the key

1. Tap Ny nyckel (New key) on the client's row.
2. The Ny nyckel för [client] (New key for [client]) box shows the key. Tap Kopiera nyckeln (Copy the key).
3. Enter the key in the system's settings, or hand it securely to the person setting up the system.
4. Tap Klar (Done).

The key is only shown this once. Vendion can never show it again. If you have lost it: create a new key and revoke the old one.

Keep the key on a server only, never in a web page or app. If it leaks: revoke it straight away and create a new one.

In the list each key is shown with its first characters, Skapad (Created) and Senast använd (Last used), or Aldrig (Never) if it hasn't been used yet.

Change keys without interruption

A client can have several keys at once. Create a new key and let the system start using it. When the new key's Senast använd shows a date, you know the system is using it. Then revoke the old one.

Revoke a key

Tap Återkalla (Revoke) next to the key and confirm with Återkalla. Systems using the key stop working immediately. The key stays in the list with the date it was revoked.

Disable a client

Tap Stäng av (Disable) on the client's row and confirm. All the client's keys are revoked and the system stops working immediately. This cannot be undone: if you need the system again, create a new client. The client stays in the list, labelled Avstängd (Disabled).

A restaurant's own keys

A single restaurant can also have its own keys. They only apply to that restaurant.

1. Open Integrationer (Integrations) in the restaurant's admin.
2. Tap Hantera (Manage) on the Vendion API card.
3. Create a client and a key the same way as above.

You need the Hantera integrationer (Manage integrations) permission in the restaurant to create and revoke there.

The chain's clients are also shown in the restaurant's list, labelled Kedjans (The chain's) with the text Kedjans klient: gäller alla restauranger i [chain]. Den hanteras av kedjan. (The chain's client: applies to all restaurants in [chain]. It is managed by the chain.) The restaurant can see them but cannot revoke or disable them. The chain's Admin group does that in the chain settings.

Vendion Integration is required

The API only reaches restaurants that have the Vendion Integration module. A restaurant without it cannot be reached, neither with the chain's keys nor with its own, while the chain's other restaurants work as usual. Contact Vendion to activate Vendion Integration.

What Vendion does

Vendion never creates keys for you and cannot see a key in full. In support, Vendion can see your clients and keys and revoke a key or disable a client, for example if a key has leaked.