Nothing Found
    Nothing Found
Help Centre
Select...

How to get credentials

In this tutorial you’ll learn how to add an app and add credentials. You’ll also learn how to manage your apps and credentials.

Go to About our APIs for more information about the authentication and authorisation protocols our APIs use.

Step 1 - Add an app

We use apps to organise the credentials you use with our APIs.

  1. Click or tap Credentials in the top menu. Alternatively, click or tap Get credentials on an API documentation page.
If the API you want to use is restricted, you need to request access before you can get credentials for it.
You need to be logged in to your Developer Portal user account to get credentials. If you aren’t logged in already, you’ll be prompted to log in or sign up.
  1. Click or tap Add app.
  1. In the Add new app screen, fill in the details of your new app and save it.
  • Type in an App name. Choose something short but meaningful.
  • Choose an App type. Make sure the app type you choose works with the credential type you want to add.
  • Click or tap Save app.
Click or tap on each app type to see more information about it, including which credential types you can add to it.
  1. When you save your app, it appears in the left menu under My apps.

Step 2 - Add a credential

  1. Make sure your app is selected in the left menu, then click or tap Add credential.
  1. In the Add credential to [your new app] page, use the type-ahead search to look for and Choose an API. Click or tap into the field and type in a keyword to find the API you want.
  1. When you choose an API, its security definitions are displayed so you know which credentials to create.
  1. If the API has more than one security definition, select the Credential type you want to create from the list. If the API only has one security definition, you can only create that one credential type.
You can only add credentials that work with the app type you chose. This means if the API needs a credential type that doesn’t work with the app type, that credential type won’t appear as an option. If you want to create it, add a new app and make sure to choose an app type that works with that credential type.
  1. Configure the credential details. Click or tap the tabs below to find out what to do for each credential type.
If you add a Basic Auth credential, there are no extra details to configure. Skip ahead to part 6 below.

Select a Restriction method to limit use of your API Key to specific sites or platforms and make your API Key more secure. Then, depending on the restriction method, type in the HTTP referrer(s), IP address(es) or iOS bundle(s).

You can only restrict an API Key to iOS bundles if the credential is in a Native app.
If you’re not sure which restriction method to choose when adding your credential, select Unrestricted and edit the credential later.
  1. Click or tap Create credential.
  2. Your new credential appears in the app you added it to.

Step 3 - Manage your apps

You can add multiple apps, or edit or delete existing apps, from the My apps page.

Click or tap Credentials in the top menu to view your apps.

  1. Add more apps

You can add as many apps to your Developer Portal account as you need for your project - there are no limits.

Click or tap the Add app button in the left menu, then follow Step 1 Add an app, above.

  1. Edit an app

Make sure the app is selected in the left menu, then click or tap the ellipsis (…) button.

Click or tap Edit app, make your changes, then click or tap Save app.

Once a credential is added to an app, you can only edit the app name. If your app doesn't have any credentials in it, you can also edit the app type.
  1. Delete an app

Make sure the app is selected in the left menu, then click or tap the ellipsis (…) button.

Click or tap Delete app, then click or tap Delete in the Are you sure? box to confirm your decision.

Make sure there are no active credentials in an app before deleting it. Once an app is deleted it can’t be restored.

Step 4 - Manage your credentials

You can add more credentials to an app, or edit or delete existing credentials, from the My apps page.

Click or tap Credentials in the top menu to view your apps.

  1. Add another credential to an existing app

Make sure the app is selected in the left menu under My apps, then click or tap Add credential. Then follow Step 2, above.

The type and number of credentials you can add to an app depends on the app type. For more information about cardinality for apps and credentials, go to About our APIs.
  1. Edit a credential

You can edit any part of a credential that you configured when you were adding it. This includes:

  • API Key: restriction methods
  • OAuth 2.0 Authorisation Code: redirect URI(s)
  • OAuth 2.0 Client Credentials: custom scopes.

Click or tap Edit on the relevant credential card, make your changes, then click or tap Save credential.

  1. Delete a credential

Click or tap Delete on the relevant credential card.

Click or tap Delete in the Are you sure? box to confirm your decision.

Make sure the credential is not active before deleting it. Once a credential is deleted it can’t be restored.