https://github.com/hackenbruder/govdata-js

GovData Javascript SDK
https://github.com/hackenbruder/govdata-js

coffeescript govdata govdata-javascript-sdk nodejs sdk

Last synced: about 2 months ago
JSON representation

GovData Javascript SDK

• Host: GitHub
• URL: https://github.com/hackenbruder/govdata-js
• Owner: hackenbruder
• License: other
• Created: 2015-08-23T21:19:11.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2017-05-30T03:57:06.000Z (about 9 years ago)
• Last Synced: 2025-12-27T09:56:06.386Z (6 months ago)
• Topics: coffeescript, govdata, govdata-javascript-sdk, nodejs, sdk
• Language: CoffeeScript
• Size: 50.8 KB
• Stars: 1
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.en.md
  • License: LICENSE.md

Awesome Lists containing this project

README

          
# GovData Javascript SDK

[Česká verze](README.md)

Official Javascript SDK with browser and Node.js support.

[![Build Status](https://travis-ci.org/hackenbruder/govdata-js.svg)](https://travis-ci.org/hackenbruder/govdata-js)

## GovData

`GovData` provides select OpenData using an API and simplifies it's integration in applications with an SDK. We currently provide data from small business, business and other registries including registry of VAT payers. Data are standardized and searchable. Our SDKs are test-covered and services highly available. We believe OpenData, APIs and SDKs create an ecosystem and high quality apps can only exist in healthy ecosystem.

Try our service and SDK for free.

## Installation

### Browsers

Easiest browser SDK integration can be done by inserting following HTML tags in your page code:

    

	

You can also install the library locally on your server and load it as your own Javascript. We support `Require.js` library. After installation, SDK creates a single object `GovData` or `window.GovData`.

### Node.js

Install the SDK with standard command:

	

	npm install govdata

Calling `require` returns a single object.

## Configuration

SDK is pre-configured to use `demo` account with our service with specific key and limits. This configuration can be used to test our service and to develop your app.

SDK configuration can be performed by calling `init` method on `GovData` object:

	

	GovData.init({ stage: '', key: '' });

## Usage

### Simple search

Find entities in business registry using `findEntityByNumber` method:

	GovData.findEntityByNumber('00006947',

		function(entity) {

			console.info('Název:', entity.getName());

		},

		function(error) {

			console.error(error.toString());

		}

	);

Please find more detailed example [here](https://gist.github.com/hackenbruder/9313b37361efab6391d5).

### Geospatial search

Entity search using GPS coordinates and radius using `findEntitiesByGeo` method:

    GovData.findEntitiesByGeo(50.08915042002743, 14.407195183397297, 100, 1,

        function(response) {

            console.info('Počet stránek:', response.getPages());

            console.info('Počet výsledků na aktuální stránce:', response.getCount());

            var results = response.getResults();

            for(var i = 0; i < results.length; ++i) {

                var r = results[i];

                console.info('Identifikační číslo:', r.getNumber(), 'Název:', r.getName());

            }

        },

        function(error) {

            console.error(error.toString());

        }

    );

## Documentation

Documenting SDK objects is in progress. Please explore available objects and their methods in [govdata.coffee](src/govdata.coffee?ts=2).

## Licence

[MIT](LICENSE.md)