/okra-node

Primary LanguageTypeScript

okra-node

okra-node is a Node.js library that simplifies interactions with the Okra API. Okra is a platform that offers APIs and tools for building financial and banking applications. This library provides an easy way to integrate Okra's features into your Node.js applications.

Table of Contents

Installation

To get started, you'll need to install the okra-node package. You can do this using npm or yarn:

npm install okra-node

Getting Started

First, you'll need an API key from Okra. Once you have your API key, you can start using the okra-node in your application.

const OkraNode = require('okra-node');

const apiKey = 'your-api-key';
const okra = new OkraNode(apiKey);

Usage

The okra-node provides methods for interacting with various Okra API endpoints. Here's an example of how to use the client to retrieve authentication data by ID:

okra.getAuthById('your-auth-id')
  .then((response) => {
    console.log(response);
  })
  .catch((error) => {
    console.error(error);
  });

You can similarly use other methods to access different Okra features like getting account details, transactions, balance, and more.

Contributing

We welcome contributions from the community! If you'd like to contribute to this project, please follow our Contribution Guidelines.

License

This project is licensed under the MIT License - see the LICENSE file for details.