Giter VIP home page Giter VIP logo

regon-js's Introduction

regon-js

A simple promise-based library to integrate REGON-API into any Node.js and browser system.

How to use

  • Install with npm npm i regon-js -S
  • or install with yarn yarn add regon-js

Example usage:

// Import with ES5
var Regon = require('regon-api').default;

// Import with ES6
import Regon from 'regon-api';

// Create a client with a configuration object
const client = new Regon({
  key: 'YOUR_API_KEY', // Required for non-sandbox mode. Your API key
  sandbox: true, // Optional. Enables sandbox mode. Off by default
});


// Without async-await
client.login().then(() => {
  const results = client.search({
    nip: 1234567890
  });
  console.log("Results", results);
})


// With async-await
await client.login(); // Log in to obtain a new session ID

const results = await client.search({
  nip: 1234567890,
});

await client.logout(); // Log out to remove the session ID

console.log('Results', results);

The data is returned in the same format as specified on the API REGON documentation (without the response wrappers)

More examples coming soon.

Contribution

Pull requests are more than welcome.

  1. Pull the repository
  2. Make changes
  3. Run build script npm run build
  4. Submit a PR

API

Table of Contents

search

Search by different keys Search is a key-value pair object with one of the following options: krs, krsy, nip, nipy, regon, regony14zn, regony9zn

Parameters

  • search

Returns Promise<any>

regon-js's People

Contributors

ikonrad avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.