Introduction
Unlock the full potential of Swyvl by integrating your Google 3D Tiles API Key. This key enables access to high-quality basemaps, providing detailed 3D imagery and terrain data that significantly enhances your projects.
The API key is managed at the Workspace level, and you’ll need to add one key per Workspace. However, you can use the same API key across multiple Workspaces if desired.
Why is an API Key Required?
Google 3D Tiles provides the following benefits to your Swyvl projects:
High-resolution imagery for better visual context.
Accurate terrain data to improve map realism and usability.
An API key is required to authenticate your usage and ensure compliance with Google’s terms of service.
Note: Google may charge for API key usage, depending on the volume of requests.
How to Get Your Google 3D Tiles API Key
Go to the Google Cloud Console:
Visit the Google Cloud Console.Create a New Project:
Click the project dropdown in the header.
Select "New Project" to create a new one if needed.
Enable the Map Tiles API:
Navigate to the APIs & Services Library.
Search for "Map Tiles API" and enable it for your project.
Set Up Billing:
Configure a billing profile to activate your API key.Generate Your API Key:
Go to the "Keys & Credentials" page.
Copy your newly created API key for later use.
Restrict Your API Key (Optional but Recommended):
Restrict the key to Swyvl usage only (e.g., https://build.swyvl.io).
Set restrictions to ensure security and prevent unauthorized usage.
Understand Quotas and Costs:
The Map Tiles API operates on a pay-as-you-go model.
Your first $200 of usage is free each month. For more details, visit Google Maps Platform Billing.
Adding Your API Key to Swyvl
Navigate to Workspace Settings:
Go to your Workspace dashboard in Swyvl.
Open the Settings menu.
Enter Your API Key:
Locate the Google 3D Tiles API Key field.
Paste your copied API key into this field.
Save Changes:
Click Save to apply your settings.
The Google 3D Tiles basemap will now be available for use across all projects in the Workspace.
Note: If when adding your API key you receive a warning 'Could not verify API key', remove the restriction to the domain https://build.swyvl.io in the Google Cloud Console. We have noticed that some new accounts don't work with this option enabled.
Tips and Notes
Restricting Your API Key: Adding restrictions ensures the key can only be used with Swyvl, minimizing security risks.
Monitor Usage: Keep an eye on your API usage to avoid unexpected charges.
Check Permissions: Ensure your Google Cloud project has the necessary permissions to enable and use APIs.