A Node.js client for the Velodrome API
npm install velodrome
API keys can be requested by emailing email@example.com.
General API documentation is available on our developer portal at https://velodrome.readme.io/.
The Velodrome API utilises HTTP Basic Auth for authentication. Each user is issued with a public and private API key. The public key is used as the Basic Auth Username and the private key is used as the Basic Auth Password. Every request is completed over SSL and HTTP Strict Transport Security (HSTS) is enforced.
This API library is based on mikeal's request library. As such each API request calls the callback provided with three parameters (error, resource, data) as in the node-request library. More info can be found in the request library documentation.
API keys are required for all requests.
Velodrome is currently only available in selected cities and orders can only be placed in Dublin, Ireland.
Include and initialise the library like so:
var velodrome = ;var api = "YOUR_PUBLIC_KEY" "YOUR_PRIVATE_KEY";
List Cities Example
The following example shows how the Velodrome Node.js module could be used to list all cities Velodrome is available in.
var velodrome = ;var api = "YOUR_PUBLIC_KEY" "YOUR_PRIVATE_KEY";api;