Developer
HomeGet startedAPI docs
Support
Log in
Sign up

Create an API key

The instructions provided here are intended for Zettle merchants when creating API keys to share with developers building Zettle integration apps. The API key is used for authorisation of an app in the assertion grant flow.
The API key must be created by a Zettle merchant account owner in my.zettle.com. There are two ways for merchants to create the API keys as described in the following.
  • If you are the developer of a self-hosted app, share this guide with the merchant that will use the app.
  • If you are a merchant, follow the steps in the guide as instructed by the developer of your integration app.

Prerequisites

  • A Zettle merchant account from my.zettle.com.
  • Depending on the API key creation method used:
    • An API creation link provided by the developer.
    • OAuth scopes provided by the developer. These are specific permissions needed to access Zettle merchant account data.

Create API key using a link

Create the API key using a specific link provided by your app developer.
  1. Open the link provided by your developer.
  2. Enter your Zettle account password.
  3. Review the information and click Create key. A client ID will be created together with the API key.
    The dialog that is started after clicking a deep link for creating API keys. The Create key button is in the lower right corner of the dialog.
  4. On the Create API key page, click Copy key. Keep the API key and the client ID as secret somewhere safe.
    The dialog to copy and save the API key. The Copy key button is in the lower right corner of the dialog.
  5. Share the API key and client ID with the developer who sent you the link. The created key is shown in the list of keys. When the integration starts using the key, the Last used column will show the last time the integration accessed your Zettle data.
    The dialog where you can see a list of created API keys and their scopes.

Create API key using OAuth scopes

Create the API key in my.zettle.com using the OAuth permission scopes provided by your app developer.
  1. Go to my.zettle.com and log in to your account.
  2. In the left panel, click Integrations.
    my zettle.com with the Integrations link in the lower left corner of the left navigation menu.
  3. In the Integration tools section, click API Keys.
    The Integrations page with the API keys link in the lower left corner of the left navigation menu.
  4. Click Create API Key.
    The Available API keys page with the Create API key button in the upper right corner before the available API keys list.
  5. Name your key, keep it short and descriptive. A good practice is to use the integration name as the key name.
  6. Select the OAuth permission scopes provided by your developer.
  7. Click Create key. A client ID will be created together with the API key.
    The dialog to select scopes for the API key you are creating. The Create key button is in the lower right corner of the dialog.
  8. Confirm your password.
  9. On the Create API key page, click Copy key. Save the API key and client ID somewhere safe.
    The dialog for copying and saving the API key. The Copy key button is in the lower right corner of the dialog.
  10. Share the API key and client ID with your developer. The created key is shown in the list of keys. When the integration starts using the key, the Last used column will show the last time the integration accessed your Zettle data.
    The Available API keys page with a list of created API keys.

Related information