TMB API Javascript library
- Install dependencies and development API keys:
npm install. - Test:
npm test. - Build:
npm run buildand check thedist/directory. - Run examples:
npm startand open https://localhost:8080/webpack-dev-server/examples/
Tar the api_v*.json files and encrypt the result for travis
(you will need to install the travis CLI client):
tar -cvf secrets.tar api_*.json
travis encrypt-file secrets.tar
rm secrets.tar
Then edit .travis.yml and edit the openssl command to use the generated -K and -iv
environment variables. For instance:
openssl aes-256-cbc -K $encrypted_0e142905b713_key -iv $encrypted_0e142905b713_iv
Make sure to not add the unencrypted key files (json or tar) to the git repo.
If needed, polyfill es6-promise.
Then, include the built dist/tmb.js library, and instantiate with your API keys. A full example:
<html>
<head>
<script type="text/javascript" src="node_modules/es6-promise/dist/es6-promise.js"></script>
<script type="text/javascript" src="dist/tmb.js"></script>
<script type="text/javascript">
// Instantiate API v2 with user keys
var api_v2_a = tmb('<your_app_id>', '<your_app_key>');
// Alternatively, indicate a JSON file location (URL) containing: {"app_id":"<your_app_id>","app_key":"<your_app_key>"}
var api_v2_b = tmb("path/to/api_keys.json");
// Access API v4 providing a valid Auth0 access token to access the api.
var api_v3 = tmb.v3('<your_access_token>');
</script>
</head>
<body>
</body>
</html>- Basic query:
api.search.query("catalunya").then(responseCallback); // Query and return a Promise- The paged results object:
function responseCallback(result) {
// 'items' is an array with the n'th page of results (defaults to 20 results per page):
numResults = result.items.length;
// 'request' contains details about the query:
result.request.text; // "catalunya"
result.request.options.resultsPerPage; // 20 by default.
// 'page' contains metadata about the paging:
result.page.isFirst; // boolean, indicates if this is the first page of results.
result.page.hasPrev; // boolean, indicates if there is a previous page of results.
result.page.hasNext; // boolean, indicates if there are further pages of results.
result.page.isLast; // boolean, indicates if this is the last page of results.
result.page.number; // page number, starting with 1.
result.page.totalPages; // total number of pages.
result.page.from; // Index of the first item in this page, with respect to the whole result set.
result.page.to; // Index of the last item in this page, with respect to the whole result set.
// And also methods to jump through pages, which in turn return a new paged results Promise, just like the original query:
pagedResults.page.first().then(responseCallback); // Jump to the first page of results.
pagedResults.page.prev().then(responseCallback); // Jump to the previous page of results.
pagedResults.page.next().then(responseCallback); // Jump to the next page of results.
pagedResults.page.last().then(responseCallback); // Jump to the last page of results.
}- Other search options:
var options = {
resultsPerPage: 15, // Set the number of results per page for this query
entitats: [api.search.ENTITATS.ESTACIONS, api.search.ENTITATS.LINIES], // Show only results for estacions and línies.
detail: true // Result items will contain extra proerties, such as geometries.
}
api.search.query("catalunya", options).then(responseCallback);All possible values for api.search.ENTITATS are: LINIES, INTERCANVIADORS, PARADES, ESTACIONS and ACCESSOS.
- Changing default options:
If you want to change the default results per page for any future queries, use the global property:
api.search.config.resultsPerPage = 50;Again, queries to the API return a Promise:
/* MIXED BUS AND METRO */
// Get all lines (mixed bus and metro)
api.transit.linies().info().then(parseLinies);
// Get all lines with a specific ID (mixed bus and metro)
api.transit.linies(22).info().then(parseLinies);
/* BUS */
// Get all bus lines
api.transit.linies.bus().info().then(parseLinies);
// Get a bus line with a specific ID
api.transit.linies.bus(22).info().then(parseLinies);
// Get all stops from a bus line (both ways, unsorted)
api.transit.linies.bus(22).parades().then(parseParades);
// Get all stops from a bus line (single way, ordered)
api.transit.linies.bus(22).parades().anada.then(parseParades);
api.transit.linies.bus(22).parades().tornada.then(parseParades);
// Get a specific stop from a bus line (doubled for stops on line ends)
api.transit.linies.bus(22).parades(2608).then(parseParades);
// Get all correspondencies for a bus stop on a line
api.transit.linies.bus(22).parades(2608).corresp.then(parseCorresp);
// Get a specific stop, not bound to a specific line
api.transit.parades(2).then(parseParades);
// Get all correspondencies for a bus stop regardless of the line it belongs
api.transit.parades(2).corresp.then(parseCorresp);
/* METRO */
// Get all metro lines
api.transit.linies.metro().info().then(parseLinies);
// Get a metro line with a specific ID
api.transit.linies.metro(2).info().then(parseLinies);
// Get all stations from a metro line
api.transit.linies.metro(2).estacions().then(parseEstacions);
// Get a specific station from a metro line
api.transit.linies.metro(2).estacions(213).then(parseEstacions);
// Get all correspondencies for a metro station
api.transit.linies.metro(2).estacions(213).corresp.then(parseCorresp);
// Get all accessos for a metro station
api.transit.linies.metro(2).estacions(213).accessos().then(parseAccessos);
// Get a particular acces for a metro station
api.transit.linies.metro(2).estacions(213).accessos(21301).then(parseAccessos);Responses are GeoJSON FeatureCollections, which look like this:
{
"type":"FeatureCollection",
"totalFeatures":1,
"features":[
{
"type":"Feature",
"id":"PARADES_ACTIVES.fid--48e04d30_1556e4280bf_-267e",
"geometry":{
"type":"Point",
"coordinates":[
2.159241480332353,
41.42154697182292
]
},
"geometry_name":"GEOMETRY",
"properties":{
"ID_PARADA":687695,
"CODI_PARADA":1244,
"NOM_PARADA":"Montserrat de Casanovas-Passerell",
"DESC_PARADA":"Montserrat De Casano/Arbós ",
"CODI_INTERC":null,
"NOM_INTERC":null,
"NOM_TIPUS_PARADA":"PALFIX",
"DESC_TIPUS_PARADA":"Parada Palfix",
"TIPIFICACIO_PARADA":"N",
"ADRECA":"Montserrat de Casanovas, 204",
"ID_POBLACIO":748,
"NOM_POBLACIO":"Barcelona",
"ID_DISTRICTE":627,
"NOM_DISTRICTE":"Horta-Guinardó",
"DATA_INICI":"2012-03-12Z",
"DATA_FI":null,
"NOM_VIA":"Carrer de Montserrat de Casanovas",
"NOM_PROPERA_VIA":"Carrer d'Arbós"
}
}
],
"crs":{
"type":"name",
"properties":{
"name":"urn:ogc:def:crs:EPSG::4326"
}
}
}A callback example:
function parseParades(featureCollection) {
featureCollecion.features.forEach(function(feature){
console.log(feature.properties.CODI_PARADA); // would be CODI_LINIA if parsing linies, or CODI_ESTACIO_LINIA if parsing estacions
});
}The Map module saves a collection of main values to build Map objects with the map library that you want.