Skip to content

Latest commit

 

History

History
55 lines (37 loc) · 3.91 KB

create-a-partner-hosted-app.md

File metadata and controls

55 lines (37 loc) · 3.91 KB

Create a partner-hosted app

A partner-hosted app is hosted by you as an integrator. To authorise, the app uses the authorisation code grant.

In an authorisation code grant flow, you use a temporary authorisation code to exchange for an access token from the authorisation server. A temporary authorisation code is generated from the authorisation server using API credentials. API credentials include a client secret and client ID.

To authorise your app using authorisation code grant, you need to get API credentials for the app by creating an app in your Dashboard on the Developer Portal.

Note: If you want to build a self-hosted app that will be hosted by merchants, create a self-hosted app.

Prerequisites

Get API credentials for a new app

If you need API credentials for a new app, create a public app in your Dashboard.

  1. Log in to the Developer Portal.

  2. On your Dashboard, click Create a new app.

    This screenshot shows the Create a new app button on the right of your Dashboard.
  3. On the Create a new app page, click Public API credentials to open the form for the new app.

  4. Fill in the form for the new app.

    This screenshot shows a form where you fill in the app name, app URL, and the company name. Optionally, you can add OAuth Redirect URIs that redirect merchants to your app after successful login to Zettle.
  5. Click Get credentials to create your API credentials.

  6. Download your API credentials and save them somewhere safe.

    This screenshot shows your API credentials and the Download credentials button.

    Tip: As the client ID doesn't change, if you lose the API credentials, you can request a new client secret.

Request a new client secret for an existing app

The client ID of an existing app doesn't change. If you need a new client secret for an existing app, request it in your Dashboard.

  1. Log in to the Developer Portal.

  2. On your Dashboard, choose the app for which you need to request a new secret. The current client secret is hidden.

    This screenshot shows where you can choose the app that needs a new client secret on your Dashboard.
  3. On the app page, click Request new client secret to deactivate the current secret and generate a new secret. The new client secret will be shown.

    This screenshot shows the Request new client secret button on the right of your Dashboard.
  4. Download your API credentials and save them somewhere safe.

Next task

Related API reference