ailos-js-wrapper v1.0.6

Ailos JS Wrapper

Wrapper JS para trabalhar com a API do Sistema Ailos.

Instalação

$ npm install ailos-js-wrapper --save

Como usar

Veja os exemplos na pasta demo

ES6

import AilosWrapper from 'ailos-js-wrapper';

const session = new AilosWrapper({
    contaCorrente: 8400000,
    senha: '00000000',
    fraseSecreta: 'aoinfinitoealem'
});

// usando método
session.account.getStatement('2018-10-03', '2018-11-06')
    .then(response => console.log(JSON.stringify(response)));

CommonJS

const AilosWrapper = require('ailos-js-wrapper').default;

const session = new AilosWrapper({
    contaCorrente: 8400000,
    senha: '00000000',
    fraseSecreta: 'aoinfinitoealem'
});

UMD in Browser

<!-- to import non-minified version -->
<script src="ailos-js-wrapper.umd.js"></script>

<!-- to import minified version -->
<script src="ailos-js-wrapper.umd.min.js"></script>

Métodos

auth()

Autentica com as credenciais da sessão e retorna o token JWT.

Argumentos

Exemplo

const session = new AilosWrapper({
    contaCorrente: 8400000,
    senha: '00000000',
    fraseSecreta: 'aoinfinitoealem'
});

session.auth()
  .then(token => {
    session.setToken(token);
  })
  .catch(error => console.error(error));

setToken(token)

Define o token JWT que será usado nas requisições.

Argumentos

Exemplo

session.auth()
  .then(token => {
    session.setToken(token);
  })

account.getBalance()

Retorna o saldo da conta.

Argumentos

Exemplo

session.account.getBalance()
  .then(data => {
    // ...
  })

account.getStatement(startDate, endDate)

Retorna o extrato da conta do período informado.

Argumentos

Exemplo

session.account.getStatement('2018-11-25', '2019-01-06')
  .then(data => {
    // ...
  })

transfer.doTransaction(value, recipient, credentials)

Efetua uma transação bancária Sistema Ailos e TED.

Argumentos

recipient (Favorecido Sistema Ailos)

recipient (Favorecido Outros Bancos)

credentials

Exemplo (Sistema Ailos)

const ailosRecipient = {
  bankCode: '85',
  agencyCode: '0101',
  accountNumber: '8400000',
  date: '2018-12-07',
  typeAccount: 1,
  typePerson: 1
};

const credentials = {
  securityLetters: 'ASD',
  password: '00000000'
};

session.transfer.doTransaction(10.50, ailosRecipient, credentials)
  .then(data => {
    // ...
  })

Exemplo (Outros Bancos)

const tedRecipient = {
  bankCode: '104',
  agencyCode: '0852',
  accountNumber: '412678',
  cpfCnpj: '98992252900',
  name: 'WOODY PRIDE',
  date: '2018-12-15',
  typeAccount: 1,
  typePerson: 1
};

const credentials = {
  securityLetters: 'ASD',
  password: '00000000'
};

session.transfer.doTransaction(10.50, tedRecipient, credentials)
  .then(data => {
    // ...
  })

transfer.getListBanks()

Retorna a lista de bancos com o código, nome e código ISPB.

Argumentos

Exemplo

session.transfer.getListBanks()
  .then(data => {
    // ...
  })

transfer.getListCooperatives()

Retorna a lista de cooperativas com o código e nome.

Argumentos

Exemplo

session.transfer.getListCooperatives()
  .then(data => {
    // ...
  })

transfer.getListAilosRecipients()

Retorna lista de favorecidos do Sistema Ailos cadastrados.

Argumentos

Exemplo

session.transfer.getListAilosRecipients()
  .then(data => {
    // ...
  })

transfer.getListTedRecipients()

Retorna lista de favorecidos de outros bancos cadastrados.

Argumentos

Exemplo

session.transfer.getListTedRecipients()
  .then(data => {
    // ...
  })

transfer.getAgencyName(agencyCode, bankCode)

Retorna nome da agência bancária.

Argumentos

Exemplo

session.transfer.getAgencyName('0852', '104')
  .then(data => {
    // ...
  })

ATENÇÃO!

NÃO utilize essa biblioteca no back-end caso utilize credenciais de outros usuários! Implemente no front-end e transfira apenas os dados necessários para o seu servidor. NÃO envie dados sensíveis de terceiros ao seu servidor sem o devido consentimento!