@coyosoftware/nova-api

What's this?

This is a wrapper for the Nova.Money API.

Please note that this package is in constant development and does not support all API endpoints yet.

What's in this document?

• Installation
• Basic example
• Supported endpoints
  • Companies
    • Attachments
    • List
    • Statement
    • Shareholders
  • Public
    • SignIn
  • Users
    • SignIn
    • Subdomains
• License

Installation

Installation is simple - just run:

npm i @coyosoftware/nova-api

Basic example

Just initialize a new NovaApi instance passing your Nova.Money subdomain:

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

Please note that the USER_API_KEY parameter is not required. If you initialize the client without it, you will have access only to the public endpoints and user sign in endpoint.

With the api client instance you can use any of the supported endpoints.

The response for all methods in the API client is an axios response object. Please refer to Axios documentation for further information about it.

Supported endpoints

Companies

Attachments

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

api.companies.attachments(companyIds);

List

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

api.companies.list();

Statement

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

api.companies.statement(companyIds, date);

Shareholders

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

api.companies.shareholders(companyId);

Public

SignIn

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN');

api.public.signIn(email, password);

Users

SignIn

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN');

api.users.signIn(email, password);

The distinction between Public Sign In and Users Sign In lies in the additional step taken by Users Sign In to verify whether the user, identified by the given email/password, has access to the specified subdomain before issuing the API token. In contrast, Public Sign In simply returns the API token without conducting any further checks.

Public Sign In proves advantageous when dealing with the same user across multiple subdomains, allowing seamless operations across them. This is possible because the API token remains valid across all associated subdomains.

Subdomains

import NovaApi from '@coyosoftware/nova-api';

const api = new NovaApi('YOUR_SUBDOMAIN', 'USER_API_KEY');

api.users.subdomain();

License

MIT License, https://opensource.org/license/mit/