Google Maps JavaScript URL Signing

!Build
!Release
!GitHub contributors

Description

Sign a URL for Google Maps Platform requests.

> Warning: It is not recommended to use this library in client side applications to avoid exposing the secret used to sign the URL.

Install

Available via npm as the package @googlemaps/url-signature.

npm i @googlemaps/url-signature

Documentation

Check out the reference documentation.

Example

Create a signature for a Google Maps request URL or url string.

``ts
const signature = createSignature("https://example.com/some-path?foo=bar", "secret");
`

Returns a new URL having a signature parameter.

`ts
const signedUrl = signUrl("https://example.com/some-path?foo=bar", "secret");
signedUrl.href; // "https://example.com/some-path?foo=bar&signature=..."
`

Create a signature for a path and query string using Hmac SHA1.

`ts
const signature = createSignatureForPathAndQuery("/some-path?foo=bar", "secret");
``

> Note: This is not an officially supported Google product