A generic RESTful NodeJS client for interacting with JSON APIs.
To use this client you just need to import ApiClient and initialize it with an API Key, Secret and URL endpoint
var api = require('node-restful-client')(apiKey, apiSecret, apiUrl);
Now that you have a RESTful API object you can start sending requests.
All requests include the following headers by default:
- 'X-Authentication-Key' - The API Key provided when creating the ApiClient object.
- 'X-Authentication-Nonce' - An incremental number to prevent request replays. By default this is the current epoch time in milliseconds.
- 'X-Authentication-Signature' - A SHA256 HMAC signature of the nonce, signed using the API Secret provided when creating the ApiClient object.
The framework supports GET, PUT, POST and DELETE requests:
api.get('/books/', {}, function (err, res) {
console.log(res);
});
api.post('/books/', {'title': 'Twilight', 'author': 'Stephenie Meyer' }, function (err, res) {
console.log(res);
});
api.put('/book/Twilight/', {'release_date': '06/09/2006' }, function (err, res) {
console.log(res);
});
api.del('/book/Twilight/', {}, function (err, res) {
console.log(res);
});
The client can be extended to be more application specific, e.g. api.createBook('Twilight', 'Stephenie Meyer', callback);
:
var RestfulClient = require('node-restful-client');
module.exports = function (apiKey, apiSecret) {
return new ApiClient(apiKey, apiSecret);
};
function ApiClient(apiKey, apiSecret) {
this.api = new RestfulClient(apiKey, apiSecret, 'http://restful.jamiecressey.com:5000');
}
ApiClient.prototype.createBook = function (data, callback) {
this.api.post('/books/', data, callback);
}
All contributions are welcome, either for new\improved functionality or in response to any open bugs.