heremaps / here-aws-sar Goto Github PK

This project provides AWS Lambdas as proxies for several of the HERE Location Services APIs. These AWS Lambdas are packaged as per the AWS Serverless Application Model.

"AWS SAR is natively supported by AWS CloudFormation and defines simplified syntax for expressing serverless resources. The specification currently covers APIs, Lambda functions and Amazon DynamoDB tables."

The AWS API Gateway supports configuring both Cache and Throttling, and the lambdas are open source: we welcome pull requests with circuit breakers, graceful error handling, etc.!

To successfully call the HERE Maps APIs through the proxies in this project you need to obtain HERE API credentials. Multiple plans are available: https://aws.amazon.com/marketplace/pp/B07JPLG9SR/?ref=_ptnr_aws_sar_github#pricing-information.

• Geocoding and Search API v7
• Map Image
• Map Tile
• Positioning
• Routing API v8 & Routing Waypoints Sequence
• Toll Costs
• Traffic
• Public Transit API v8
• Weather

• Step 1: Register for an API Key

  Visit the HERE Location Services on AWS Marketplace, and review the Access Control FAQ.

• Step 2: Register an AWS Account

  Visit AWS and sign up for a Free Tier account.

• Step 3: Install the AWS CLI and run "aws configure"

  Download and install the AWS CLI, and run aws configure as per the AWS CLI User Guide.

• Step 4: Get the Source

  From GitHub: clone this repository, or download the ZIP.

  The folder containing the lambda source code (JS) and CloudFormation templates (YML) is serverlessFunctions.

• Step 5: Package

  An S3 bucket is required as a destination for the AWS SAR package. If you don't have one already, create one:

  
  Note: If the folder contains a `package.json` file: run `npm update`:
  
  `x:\src\here-aws-repository\serverlessFunctions\mapimage>npm update
  

  Use the AWS CLI to package (note the folder layout):

  x:\src\here-aws-repository\serverlessFunctions>aws cloudformation package --s3-bucket here-maps-api--aws-sar --template-file geocode\geocode.yml --output-template-file geocode-packaged.yml

• Step 6: Deploy

  Use the AWS CLI to deploy the AWS SAR package using CloudFormation:

  x:\src\here-aws-repository\serverlessFunctions>aws cloudformation deploy --capabilities CAPABILITY_IAM --stack-name "HERE-Maps-API--GeoCode" --parameter-overrides HereApiKey=<apiKey> --template-file geocode-packaged.yml

• Step 7: Find new API Gateway URL

  Once deployment completes, look for the URL of the new API Gateway. It should follow this pattern:

  https://<apigw>.execute-api.<region>.amazonaws.com/...

  The API Gateway URL is an output from the CloudFormation template and can be found among the tabs when selecting a Stack in the AWS Console.

  Alternatively look at the API Gateway in the AWS Console, select Stages, and then expand the tree until you see "Invoke URL".

• Step 8: Secure your API Gateways/Lambdas

  The AWS Lambda proxies deployed above do not impose authentication or authorization restrictions!

You must decide how you will control access to your API Gateway and Lambdas.

For guidance, see the AWS Lambda FAQ.

Consider implementing AWS API Gateway Custom Authorizers.

The below list of HERE Maps APIs has one Lambda each as a proxy.

Note:

• All APIs except Map Image and Map Tile will return JSON response. For error scenarios, response JSON will be with 4xx - 5xx response code and details of error.

• For Map Image and MapTile APIs, success response will return base 64 encoding of map image (not JSON) and for failures, message as error in downloading map will be returned.

Copyright (c) 2017-2019 HERE Europe B.V.

See the LICENSE file in the root of this project for license details.