turbasen.js
Node.JS-client for Nasjonal Turbase.
Requirements
- Node.JS >= v4.0.0
Install
npm install turbasen --save
API
var turbasen = ;
Object Types
Data Type | API object |
---|---|
Areas | turbasen.områder.… |
Photos | turbasen.bilder.… |
Places | turbasen.steder.… |
Trips | turbasen.turer.… |
Activities | turbasen.aktiviteter.… |
Groups | turbasen.grupper.… |
Status Codes
Code | Explanation |
---|---|
200 |
Everything is OK |
201 |
Object created |
204 |
As 200 without any body |
400 |
Body is missing |
400 |
ObjectId is invalid |
401 |
Credentials are invalid |
403 |
Rate limit is exceeded |
403 |
Request was denied |
404 |
Resource was not found |
404 |
Object was not found |
405 |
HTTP method X is not allowed |
422 |
Body should be a JSON Hash |
422 |
Data validation failed |
500 |
Internal server error |
Configure
The following configurations are read from environment variables when this module is loaded:
NTB_API_KEY
- API key for authenticate requestsNTB_API_ENV
- API environment (defaultapi
, can bedev
)NTB_USER_AGENT
- User Agent for API requests
These configurations can be overloaded using the turbasen.configure()
like
this:
turbasen;
List Objects
turbasen;
Each Object
Asyncronously featch each object for a given query.
{ // do something async with the item ;}; turbasenområder;
Create Object
turbasenbilder;
Get Object
turbasenbilder;
Delete Object
turbasenbilder;
Put Object
turbasenbilder;
Patch Object
turbasenbilder;