Where your API key runs

Where the SDK runs decides how much care your API key needs:

• The Services bundle runs in Node.js, so search, geocoding, routing and traffic calls can run on a server, in a cron job or a script, with no front-end at all.
• The Map bundle renders in the browser, so any key it uses travels to the browser with it.

TomTom’s API key management best practices cover keys in general: scoping, segregation, rotation and monitoring. What follows is specific to the SDK, and to a key that has to sit in a page.

Which situation you are in

Server-side apps (Node.js)

In a nightly geocoding job, a CLI script, your own API that calls routing, a queue worker, or tests and CI, the key stays inside your infrastructure. You don’t need the proxying and hardening guides.

Read the key from the environment instead of your source code:

1
import { TomTomConfig } from '@tomtom-org/maps-sdk/core';
2

3
TomTomConfig.instance.put({
4
    apiKey: process.env.TOMTOM_API_KEY,
5
});

Two things are specific to the SDK:

• Redact both forms of the key in your logs. Some services send it as a TomTom-Api-Key header and others as a key= query parameter (which is which).
• The SDK already retries and validates. It retries 429 responses with backoff limited by retry.timeoutMs. It also validates requests by default, so it rejects a malformed one before it becomes a billable call. A retry loop of your own multiplies the attempts.

On a server, the realistic failure is your own code, since every call is billed. Count a batch job’s input before you start it, cap concurrency, and cache what you have already resolved.

If your Node.js code serves a front-end, keep the key out of everything you return to the browser, including config endpoints, server-rendered HTML and serialized state blobs.

Browser apps

A page that shows a map needs a key in the browser. For most applications that is fine.

Take a second look if your application is public and anonymous. Anyone who opens the page can read the key and use it from their own application, on your bill. Behind a login, you know who your users are. Self-service signup counts as public.

Ask yourself: if someone started using your key from their own application tomorrow, would you find out? If not, take these measures. They are settings on the key in the dashboard, not something you build:

• A domain whitelist, so a copy stops working from anyone else’s page. It is the cheapest measure there is, but it does not stop a non-browser client.
• Only the products you use, so a copy buys less than full access.
• One key per application and environment, so a compromise is contained and you can revoke without a coordinated release.
• Query limits, which turn an open-ended bill into a capped one.
• Per-key analytics, because how quickly you notice decides how big the surprise gets.
• Rotation on a schedule. A rotated key stays valid for up to 48 hours, which is your window to ship a new build and let caches drain.

The best practices detail each. Together they cap the damage and make a leak visible quickly, which is enough for many applications.

When a proxy is worth it

Only a server, your own or a proxy, takes the key off the page. The measures above leave the key public and limit what it is worth, which is often the right trade.

Two cheaper steps come first:

• Move service calls into your own backend. That takes the key off those calls, but the browser still fetches the map’s tiles.
• Set the key restrictions above. It takes an afternoon and no infrastructure.

Move to a proxy when a stolen key would be a bill you would notice, when your application is public and anonymous at meaningful volume, or when you rotate keys because of abuse, not policy. An unguarded proxy is just your key with extra steps, so treat proxying your API calls and hardening your proxy as one job.

Next steps

• Proxying your API calls - The SDK’s built-in proxy mode, and what the proxy itself needs to do.
• Hardening your proxy - The checks that keep the proxy from becoming a public key of its own.
• Global configuration - Where apiKey and commonBaseURL are set, including in Node.js.
• API key management best practices - TomTom’s platform guidance on restrictions, rotation, segregation and monitoring.
• Securing your agent - If you build with the Agent Toolkit, the model provider key needs the same treatment, plus limits of its own.