API - APIX File (Gerar os arquivos APIX001 e APIX002)

About bh2

A bh2 é uma Consultoria de Negócios e Desenvolvimento de Software que atua principalmente no Mercado Financeiro. Temos auxiliado diversas empresas na construção e evolução da Transformação Digital, desde grandes instituições a startups que validaram seus produtos no Lift (Laboratório de Inovações Financeiras Tecnológicas - Coordenado pela Fenasbac e Banco Central). O Pix e Open Banking estão em alta por aqui.

Description

O objetivo deste repositório é oferecer um meio de auxiliar os desenvolvedores na geração dos arquivos APIX001 e APIX002, devem ser enviadas nestes arquivos informações do Arranjo de Pagamentos Pix definidas pela Instrução Normativa nº 32, de 26 de outubro de 2020. Fiquem à vontade para contribuir neste repositório.

Material de apoio:

• Remessa de Informações Relativas ao Arranjo de Pagamento Pix
• Layout do Arquivo
• Manual de Tempos do Pix
• Arquivo XSD
• Arquivos de Exemplo

=> Para envio das informações deverão ser observados os procedimentos dispostos no Anexo II à Instrução Normativa nº 32, de 2020, bem como as orientações específicas a serem divulgadas pelo Banco Central do Brasil.

A API contém duas rotas principais:

• /api/arquivos => Geração do arquivo a partir de um payload em JSON que devolve o XML.
• /api/arquivos/upload-csv => Geração do arquivo a partir de um CSV customizado, este CSV permite uma extração simples das informações de bases de dados para gerar o XML. Arquivo de demonstração em src/files.

API - Stack:

• TypeScript.
• Node.js.
• Hapi.
• Hapi-swagger.
• XHelpers-api 2.+.
• Docker.

State

Develop	[pending]
Homolog	[pending]
Production	[pending]

Installation

$ npm install

Configuration

API configuration on .env file.

DEVS: Create .env file on root folder.

# server params
NODE_ENV=dev
LOG_LEVEL=HIGH
PORT=300
HOST=localhost
SSL=false

Running the app

# build tsc
$ npm run build

# development 
$ npm run dev

# development (only windows)
$ npm run devw

# production
$ npm run start

Routes

Starting Xhelpers Hapi server API
Settings API: Mongoose disabled;
Settings API: Sequelize disabled;
Settings API: SSL disabled;
Settings API: AppKey disabled;
Settings API: JWT enabled;
Settings API: SSO disabled;
====================================================================================================
🆙  Server api    : http://localhost:300/
🆙  Server doc    : http://localhost:300/documentation
🆙  Server status : http://localhost:300/status
====================================================================================================
Routing table:
        🔎  get -       /documentation
        🔎  get -       /health
        🔎  get -       /status
        🔎  get -       /swagger.json
        🔎  get -       /api/arquivos/demo
        🔎  get -       /api/arquivos/schema
        📄  post -      /api/arquivos/upload-csv
        📄  post -      /api/arquivos/

Cloud (AWS/Azure/GCP/Heroku)

DEMO: https://apix-ms.bh2.tech/documentation

Docker build

$ api-apix

Test

[Pending]

Support

[Pending]

Stay in touch

• Author - bh2
• Website - bh2.com.br

License

MIT License