A utility to sign static map URLs.
Inspired by url-signer.
Help is Always Appreciated! If you would like to help make this code better get in touch by opening an issue.
You must first initialize the singleton:
var urlSign = require('google-signed-url');
urlSign.init({
latitude: <LATITUDE>,
longitude: <LONGITUDE>,
zoom: <ZOOM LEVEL>,
size: <e.g.'600x600'>,
maptype: <'roadmap', 'satellite', 'hybrid', 'terrain'>
markerColor: <e.g. '0x9F2538'>,
client: <CLIENT ID>,
privateKey: <PRIVATE KEY>
});Then you can sign the URL:
var signedUrl = urlSign.getSignedUrl();You don't need to pass in any additional parameters.
NOTES:
-
This module assumes you want to place a single marker on the static map and that the coordinates match the lat/long in the singleton. This should be modified in the future to allow for more flexibility.
-
Use something like dotenv to store your Client ID and Private Key as environment variables instead of having them in your code.
MIT License
Copyright (c) 2017 Anne Canoune
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.