dslab.playandgo.test

Track Verification Test

with Here API

---

Table of Contents

1. About the Project
2. Environment Variables
3. Here API

---

About The Project

This project integrates with the HERE API to retrieve a specific route information based on the origin, destination and transport mode chosen by the user. It processes this data into a predefined template with Thymeleaf and enables verification of the route within the PlayAndGo platform.

(back to top)

---

Environment Variables

Warning: ALL Environment Variables are mandatory.

• API_ENDPOINT

  The apiEndpoint variable represents the base URL for the API of the PlayAndGoEngine.
  
  Example: https://localhost:{port}/playandgo/api

• CAMPAIGN_ID:

  Variable used by the PlayAndGoEngine to assign a survey and/or to send a challenge invitation, of a specific campaign, to a player.
  
  Temporary Value: TAA.city

• DEPARTURE_TIME:

  Departure Date and Time assigned to the Route created by the Here API.
  Attention! Be sure to use the right format: "yyyy-MM-dd'T'HH:mm:ss"
  
  Example: 2024-11-11T00:00:00

• END_WEEK:

  End Date and Time used by the TemplateManager to set the ending date of the survey in the template.
  Attention! Be sure to use the right format: "yyyy-MM-dd'T'HH:mm:ss"
  
  Example: 2024-11-15T00:00:00

• HERE_API_KEY:

  This is the Specific Key to access the HERE API.
  To create it you need to have an account on HERE Api and generate it.
  In the HERE Api Section you will have access to all the documentation to set and start using Here API.

• HERE_ROUTE_API_URL:

  This is the base URL for the HERE Routing API.
  It is used to create a route between two points only if the transport mode is walk or bike.
  
  Value: https://router.hereapi.com/v8/routes

• HERE_TRANSIT_API_URL:

  This is the base URL for the creation of the API Request of HERE Public Transit API.
  It is used to create a route between two points only if the transport mode is bus, train or any other public transportation.
  
  Value: https://transit.router.hereapi.com/v8/routes

• OUTPUT_DIR:

  Personal output directory to where the final templates will be saved before sending them to the Backend of PlayAndGo for the verification of the track.
  
  Example for Linux: /home/username/Documents/testResults

• PLAYER_ID:

  Variable used by the PlayAndGoEngine to assign a survey to a specific player.
  
  Temporary Value: u_fe939cab-1638-45b3-a604-80a3fb018e54

• PLAYER_TO_INVITE:

  Variable used by the TemplateManager to set the playerId inside the template for the challenge invite.
  
  Temporary Value: u_11111

• START_WEEK:

  Start Date and Time used by the TemplateManager to set the starting date of the survey in the template.
  Attention! Be sure to use the right format: "yyyy-MM-dd'T'HH:mm:ss"
  
  Example: 2024-11-11T00:00:00

• TOKEN:

  Authentication Token of AAC to access the Backend of PlayAndGo.

---

Since the test still not implements survey and challenge invite, the following variables can be set to empty, but MUST be declared:

1. CAMPAIGN_ID
2. PLAYER_ID
3. PLAYER_TO_INVITE

(back to top)

---

Here API

HERE API is a suite of location-based services provided by HERE Technologies, a leading company in mapping and geospatial data. It offers features such as mapping, routing, traffic, and transit information, enabling applications to deliver real-time navigation, route optimization, and location intelligence.

Get Started:

1. Get an API Key
2. Manage a Project
3. Add a Service to a Project

You MUST add the following Services to your Project:

1. HERE Routing v8
2. HERE Routing - Transit v8

Other Guides:

• Example: Calculate a Transit Route
• HERE Official Tutorials

---

Here API Reference:

The API references below are provided just to have a better understanding of the HERE API.
You will not need to know it perfectly to use this application since the test will automatically change the APIs parameters based on the initial request.

• Routing API Documentation
• Public Transit API Documentation

(back to top)