Regon-js NPM | npm.io

regon-api

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.searchByNip('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.