fvdm / nodejs-overheid.io Goto Github PK

View Code? Open in Web Editor NEW

0.0 3.0 0.0 74 KB

Access overheid.io endpoints like OpenKvK, RDW and BAG with node.js

Home Page: https://www.npmjs.com/package/overheid.io

License: The Unlicense

JavaScript 100.00%

overheid nodejs government api-client dutch register unlicense

nodejs-overheid.io's Introduction

overheid.io

overheid.io API wrapper

Example

// Configuration
var ovio = require ('overheid.io') ({
  apikey: 'abc123',
  dataset: 'rdw'
});


// Post process callback
function postProcess (err, data) {
  console.dir (err || data, {
    depth: null,
    colors: true
  });
}


// Get details about one license plate
ovio ({
  path: '4-TFL-24',
  params: {
    fields: ['eerstekleur', 'vervaldatumapk']
  },
  callback: postProcess
});


// Search the dataset
ovio ({
  params: {
    filters: { merk: 'bmw' }
  },
  callback: postProcess
});

Installation

npm install overheid.io

Configuration

This module provides one function, use it for configuration.

Config parameters

param	type	required	default	description
apikey	string	yes		Your account API key
dataset	string	no		Which dataset to use
timeout	integer	no	5000	Wait time out in ms

var ovio = require ('overheid.io') ({
  apikey: 'abc123',
  dataset: 'voertuiggegevens'
});

API function

param	type	required	default	description
path	string	no		Resource path, i.e. `DA-GO-12`
params	object	no		Parameters to send along
dataset	string	no	`config.dataset`	Which dataset to use
timeout	integer	no	`5000` or `config.timeout`	Wait timeout in ms
callback	function	yes		`function (err, data) {}`

See Example above

Errors

message	description	properties
request failed	The request failed	`.code`, `.error`, `.error.code`
no results	The result was empty	`.code`
API error	The API returned an error	`.code`, `.error`
invalid response	The API returned invalid data	`.code`, `.body`

Unlicense

This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute this software, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

In jurisdictions that recognize copyright laws, the author or authors of this software dedicate any and all copyright interest in the software to the public domain. We make this dedication for the benefit of the public at large and to the detriment of our heirs and successors. We intend this dedication to be an overt act of relinquishment in perpetuity of all present and future rights to this software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to http://unlicense.org/

Author

Franklin van de Meent

nodejs-overheid.io's People

Contributors

Watchers

nodejs-overheid.io's Issues

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet. We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please delete the greenkeeper/initial branch in this repository, and then remove and re-add this repository to the Greenkeeper integration’s white list on Github. You'll find this list on your repo or organization’s settings page, under Installed GitHub Apps.

An in-range update of dotest is breaking the build 🚨

The devDependency dotest was updated from `2.6.0` to `2.6.1`.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

dotest is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details

❌ continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Commits

The new version differs by 3 commits.

2638309 2.6.1
8b2fd56 Docs(changelog): Update changelog
682dc72 Fix: Coverage didn’t run in the pkg context

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.

Your Greenkeeper Bot 🌴

An in-range update of eslint is breaking the build 🚨

Version 4.13.0 of eslint was just published.

Branch	Build failing 🚨
Dependency	eslint
Current Version	4.12.1
Type	devDependency