Skip to content
No description, website, or topics provided.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
config
controllers
helpers
logs
models
plugins
solr-files
test
.editorconfig
.gitignore
.jshintignore
.jshintrc
.travis.yml
README.md
apiary.apib
package.json
server.js

README.md

Biz Finance API

Build Status

Index

CORS

Making CORS work properly if you use custom headers is not always straightforward (restify / Issue #284). The boilerplate provides a helper, which takes care of MethodNotAllowed repsonses in conjunction with preflight requests + custom headers.

Authorization

Every request you make must be authenticated. The REST API uses a custom HTTP scheme based on a keyed-HMAC (Hash Message Authentication Code) for authentication.

The value of the Authorization header is as follows:

Authorization: <Config/Security/Scheme> <AccessKey>:<Signature(Base64(HMAC-SHA1(UTF-8(<String to Sign>), UTF-8(<SecretAccessKey>))))>

AccessKey: Provided by config/global.json SecretAccessKey: Provided by config/global.json String to Sign: Value of the <Config/Security/DateIdentifier> header

You can find an example in the examples/client branch.

Logging

By default node-bunyan is used for logging to a file (./logs/{{NODE_ENV}}-{{SERVER:NAME}}.log). Additionally sending logs to Loggly is supported (take a look at the config file).

You can’t perform that action at this time.