Use API Keys with Address Validation API

Google Maps Platform products are secured from unauthorized use by restricting API calls to those that provide proper authentication credentials. These credentials are in the form of an API key - a unique alphanumeric string that associates your Google billing account with your project, and with the specific API or SDK.

This guide shows how to create, restrict, and use your API key for Google Maps Platform.

Before you begin: Before you start using the Address Validation API, you need a project with a billing account and the Address Validation API enabled. We recommend creating multiple Project Owners and Billing Administrators, so that you'll always have someone with these roles available to your team. To learn more, see Set up in Cloud console.

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:
1. To accept requests from the list of web server IP addresses that you supply, select IP addresses (web servers, cron jobs, etc.) from the list of Application restrictions. Specify one or more IPv4 or IPv6 address, or subnet using CIDR notation. The IP addresses must match the source address the Google Maps Platform servers observe. If you use network address translation (NAT), this would typically correspond to your machine's public IP address.
• API restrictions:
1. Click Restrict key.
2. Select Address Validation API from Select APIs dropdown. If the Address Validation API is not listed, you need to enable it.
4. To finalize your changes, click Save.
   

Cloud SDK

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=addressvalidation.googleapis.com
    --allowed-ips="IP_ADDRESS"

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

Adding the API key to your request

You must include an API key with every Address Validation API request. In the following example, replace YOUR_API_KEY with your API key.

https://addressvalidation.googleapis.com/v1:validateAddress?key=YOUR_API_KEY

HTTPS is required for requests that use an API key.

Note: When using Web Services, all special characters inside the parameters must be URL encoded. URLs must be properly encoded to be valid and are limited to 2048 characters for all web services. Be aware of this limit when constructing your URLs. Different browsers, proxies, and servers may have different URL character limits as well.