README

Aaro REST API - JavaScript Library

New JavaScript library for Aaro REST API, supports CommonJS (CJS).

Requests are made with Axios library with support to promises.

Installation

npm install --save aaro

Getting started

Generate API credentials (Bearer Token) following this instructions https://aaro-api.netlify.app/#authentication/ .

Check out the Aaro API endpoints and data that can be manipulated in https://aaro-api.netlify.app/.

Setup

CJS example:

const { Aaro, Token } = require('aaro');

(async () => {
    const baseUrl = 'https://erp.aaro.com.tr';

    const token = await Token(baseUrl, 'username', 'password').then(
        (rp) => rp.data.access_token
    );

    const aaro = new Aaro({
        baseUrl,
        accessToken: token,
    });

    aaro.get('Stok', {
        SayfaSatirSayisi: 100,
        StokID: '1567,1562',
    }).then((response) => console.log(response.data.Model.length));
})();

Options

Option	Type	Required	Description
`baseUrl`	`String`	yes	Your Erp URL, example: https://erp.aaro.com.tr
`accessToken`	`String`	yes	Your bearer token
`encoding`	`String`	no	Encoding, default is 'utf-8'
`timeout`	`Integer`	no	Define the request timeout
`axiosConfig`	`Object`	no	Define the custom Axios config, also override this library options

Methods

GET

.get(endpoint)
.get(endpoint, params)

Params	Type	Description
`endpoint`	`String`	Aaro API endpoint, example: `Stok` or `Stok/StokMiktarListe`
`params`	`Object`	Query strings params, example: `{ sayfa: 2, SayfaSatirSayisi:100 }`

POST

.post(endpoint, data)
.post(endpoint, data, params)

Params	Type	Description
`endpoint`	`String`	Aaro API endpoint, example: `Stok` or `Depo`
`data`	`Object`	JS object to be converted into JSON and sent in the request
`params`	`Object`	Query strings params

PUT

.put(endpoint, data)
.put(endpoint, data, params)

Params	Type	Description
`endpoint`	`String`	Aaro API endpoint, example: `StokVergi`
`data`	`Object`	JS object to be converted into JSON and sent in the request
`params`	`Object`	Query strings params

DELETE

.delete(endpoint)
.delete(endpoint, params)

Params	Type	Description
`endpoint`	`String`	Aaro API endpoint, example: `Stok` or `Depo`
`data`	`Object`	JS object to be converted into JSON and sent in the request

Example of use

const { Aaro, Token } = require('aaro');

(async () => {
    const baseUrl = 'https://erp.aaro.com.tr';

    const token = await Token(baseUrl, 'username', 'password').then(
        (rp) => rp.data.access_token
    );

    const aaro = new Aaro({
        baseUrl,
        accessToken: token,
    });

    aaro.get('Stok', {
        Sayfa: 1,
        SayfaSatirSayisi: 10,
        StokID: '1567,1562,8591,1531,7879,7875,6382,6384,6383,7879,6385',
    }).then((response) => console.log(response.data.Model));
})();

Changelog

See changelog for details

Usage no npm install needed!