https://github.com/algoan/rest-nodejs

Algoan REST API Client for Node.js
https://github.com/algoan/rest-nodejs

algoan nodejs rest-api sdk

Last synced: 5 days ago
JSON representation

Algoan REST API Client for Node.js

• Host: GitHub
• URL: https://github.com/algoan/rest-nodejs
• Owner: algoan
• Created: 2020-06-12T15:53:03.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-03-15T14:22:10.000Z (over 1 year ago)
• Last Synced: 2024-05-29T19:07:00.526Z (6 months ago)
• Topics: algoan, nodejs, rest-api, sdk
• Language: TypeScript
• Homepage: https://developers.algoan.com/api
• Size: 5.48 MB
• Stars: 5
• Watchers: 4
• Forks: 11
• Open Issues: 17
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        


  



**⚠️ This SDK is not maintained anymore and we strongly recommend not using it! However, you could use the [RequestBuilder](https://github.com/algoan/rest-nodejs/blob/master/src/RequestBuilder.ts) which is generic and can be useful to authenticate your project to Algoan APIs.**

# NodeJS Algoan API SDK

JavaScript client for [Algoan](https://www.algoan.com): wrap all APIs for developers using [Algoan's APIs](https://developers.algoan.com/api).

## About Algoan

We believe at Algoan that consumer loans when wisely managed create positive economic value.

Our aim is therefore to design for our partners the ultimate credit experience to best serve their customers.

## Installation

First, install this module running:

```bash

npm install @algoan/rest

```

## Usage

After installing the module, you can now instantiate a instance of Algoan. Please note that **credentials are required in order to test the Algoan class**.

```typescript

import { Algoan } from '@algoan/rest';

const client: Algoan = new Algoan({

  baseUrl: 'https://...',

  clientId: '{your_client_id}',

  clientSecret: '{your_client_secret}',

});

```

## API

To be able to use this SDK, you need to ask to an Algoan administrator credentials to [[email protected]].