Gathers real time data from external APIs and serves the data in standard format for Busse application. The external APIs use SIRI standard.

This API fetches newest data from original APIs in 1000ms interval.

Goals:

• Reliable
• Fast on bad network
• Works offline
• Indicates the freshness of data

Shortcuts:

• Developer documentation
• API endpoints

• Node.js express app
• Written in ES6
• Mocha for testing
• Winston for logging

• GET /vehicles List real time locations of vehicles

  Parameters

  All parameters are optional

  • area One or multiple areas. Valid values: helsinki, tampere, oulu,

  • line One or multiple vehicle lines. Format: <area>:<line>, e.g. helsinki:1

  • bounds Array of latitude and longitude coorinates to form a polygon, which limits the area where to return vehicles. This is an array of points. Format for single coordinate: <lat>:<lng>. Example request: ?bounds=61.4976153:23.7662998&bounds=62.4976153:23.7662998&bounds=61.4976153:23.7662998&bounds=60.4976153:21.7662998.

    This can be used to reduce amount of data transferred on each request. Minimum of 3 points must be given. Most common use case is to give boundaries of view port of the map.

• GET /areas List possible areas

• GET /messages List all Busse messages

Example object:

{
    "id": "PAUNU_165",
    "type": "bus",
    "line": "1A",
    "latitude": 61.471807,
    "longitude": 23.756158,
    "rotation": 41,
    "responseTime": "2015-09-03T22:13:17.274Z",
    "area": "tampere"
}

Example object:

{
  "id": "helsinki",
  "name": "Helsinki",
  "lines": [{"id": "1A", "type": "bus"}],
  "latitude": 61.4976153,
  "longitude": 23.7662998
}

Example object:

{
  "id": "1A",
  "type": "bus"
}

Example object:

{
  "id": "1",
  "expires": "2015-09-06T11:48:36.035Z",
  "html": "Busse is temporarily using HERE maps. <a href='https://twitter.com/bussefi'>Read more: twitter.com/bussefi<a>"
}

When HTTP status code is 400 or higher, response is in format:

{
  "error": "Internal Server Error"
}

When HTTP status code is below 400, there might be still errors with different adapters. These errors are defined in the following format:

{

  "errors": [
      {"adapter": "tampere", "error": "Empty response from original server"},
      {"adapter": "helsinki", "error": "Some error"}
  ]
}