Using API Keys

Creating API keys

The API key is a unique identifier that authenticates requests associated with your project for usage and billing purposes. You must have at least one API key associated with your project.

To create an API key:

Console

1. Go to the Google Maps Platform > Credentials page.

   Go to the Credentials page

2. On the Credentials page, click Create credentials > API key.
   The API key created dialog displays your newly created API key.
3. Click Close.
   The new API key is listed on the Credentials page under API keys.
   (Remember to restrict the API key before using it in production.)

Cloud SDK

gcloud alpha services api-keys create \
    --project "PROJECT" \
    --display-name "DISPLAY_NAME"

Read more about the Google Cloud SDK , Cloud SDK installation , and the following commands:

• gcloud alpha services api-keys create

Restricting API keys

Google strongly recommends that you restrict your API keys by limiting their usage to those only APIs needed for your application. Restricting API keys adds security to your application by protecting it from unwarranted requests. For more information, see API security best practices.

When restricting an API key in the Cloud console, Application restrictions override any APIs enabled under API restrictions. Follow best practices by creating a separate API key for each app, and for each platform on which that app is available.

To restrict an API key:

Console

1. Go to the Google Maps Platform > Credentials page.

   Go to the Credentials page

2. Select the API key that you want to set a restriction on. The API key property page appears.
3. Under Key restrictions, set the following restrictions:
• Application restrictions:
• API restrictions:
1. Click Restrict key.
2. Select Navigation SDK from Select APIs drop-down. If the Navigation SDK is not listed, you need to enable it.
4. To finalize your changes, click Save.
   

gcloud CLI

List existing keys.

gcloud services api-keys list --project="PROJECT"

Clear existing restrictions on existing key.

gcloud alpha services api-keys update "projects/PROJECT/keys/KEY_ID" \
    --clear-restrictions

Set new restrictions on existing key.

gcloud alpha services api-keys update projects/PROJECT/locations/global/keys/KEY_ID \
    --api-target=service=navigationsdk.googleapis.com

Read more about the Google Cloud SDK , Cloud SDK installation , and the following commands:

• gcloud alpha services api-keys update
• gcloud alpha services api-keys lookup
• gcloud services api-keys list

What's next

Now that you have an API key, create and configure a project as described in Set Up an Xcode Project.

Set up your Xcode project