home

MinistryPlatform

RealmRealm AccountingMinistryPlatformeGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite
RealmRealm AccountingMinistryPlatformeGivingPDSACSConnectShepherdGrowth MethodHeadMasterRefresh WebsitesTrust CenterGo MethodMissionInsite

What would you like to know more about?

Show Contents

Show Page Sections

thumbnailMinistryPlatform

Configuration Settings

Google Maps API Key

A Google Maps Javascript API key is required to use mapping features of the following Tools and Applications:

Getting a Maps API Key

Google Maps Console

Go to the Console: https://console.cloud.google.com/google/maps-apis/

Note: A Billing Account is required to use API keys. There is an Always Free Tier and you won't be changed unless you upgrade. This tier is essentially a monthly credit from Google. You'll need to provide a credit card to cover any possible charges over the credit amount. Mapping data points does not incur a cost.
Resources from Google:

Enable APIs

Enable all of the following APIs by selecting them and clicking Enable. If these APIs are not enabled, your maps won't render.
  • Maps Embed API
  • Maps Javascript API
  • Maps Static API
  • Places API for Web

Google Cloud Platform showing the apps to enable

Google Cloud Platform showing the Enable button under one of the apps

Create or Copy an API Key

  1. Credentials:
    1. Select Maps Embed API or Maps Javascript API.
    2. Select Credentials.
  2. Create a New Key or Select Existing Key.
    1. If you do not already have one listed, create a new API Key.

Configure Key for Platform URL

  1. Select the API Key (in the Credentials screen).
  2. Under Application Restrictions, select HTTP Referrers (web sites).
  3. Under Accept requests from these http referrers (web sites) enter your Platform URL.
Your Platform URL will look like this where "{domain-url}" is the URL to your MinistryPlatform installation: https://{domain-url}/*

Configure Key for Two Cloud URIs

  1. Select the API Key (in the Credentials screen).
  2. Under Application Restrictions, select HTTP Referrers (web sites).
  3. Under Accept requests from these http referrers (web sites), enter your Cloud URL. To find your Cloud URL, see Find your Cloud URL for Cloud Tools & Batch Manager and Find Your Cloud URL for Life Apps & Template Editor. Be sure to add "/*" to the end of your URL.

    Platform & Widgets Cloud URL: https://churchname.ministryplatform.cloud/*

    Tools & LifeApps Cloud URL: https://churchname.cloudapps.ministryplatform.cloud/*

Configure Key for Widgets URL

Note: Diocesan Customers: You must allow domains for each of your parishes in order for some widgets to work correctly.
  1. Select the API Key (in the Credentials screen).
  2. Under Application Restrictions, select HTTP Referrers (web sites).
  3. Under Accept requests from these http referrers (web sites), enter your widgets URL. Your widgets URL is the website where you are embedding widgets. Make sure to add "/*" to the end of your URL.

Add the Google Maps API to the Configuration Setting

  1. Go to Administration > Configuration Settings.
  2. Find the COMMON, GoogleMapsAPIKey.
  3. Click Edit Record.
  4. Paste your API key into the value field.
    Tip: Be sure that there are no spaces before or after your API key.
  5. Click Save.

Add the Google Maps API to Your Domain

  1. Copy the key using the copy icon in the Google Maps Console.
  2. Add the Google Maps API key to your domain record.
    1. Go to System Setup > Domains/Accounts.
    2. Open the Domain Record.
    3. Click Edit.
    4. Scroll to the very bottom.
    5. Paste the value into the Google Maps API key field.
    6. Click Save.

Google Maps API Key Troubleshooting

After you get your Maps API key and configure the Platform, if widgets are not updating based on changes to your API key, you may need to recycle your widget app pool.

Contact Support for help with this.

MinistryPlatform
portal

Last updated: May 17, 2024