Elixir/Phoenix application for bidirectional file exchange with Brazil Central Bank's STA WebService
| English | Portugues |
|---|---|
| Getting Started | Primeiros Passos |
| API Reference | Referencia API |
| Architecture | Arquitetura |
| Deployment | Implantacao |
STA Connector provides a robust bridge between your systems and Brazil Central Bank's STA (Sistema de Transferencia de Arquivos) WebService.
+-------------------+ +------------------------+ +-------------------+
| Your Systems |<------->| STA Connector |<------->| BCB STA |
| (REST API) | | (Elixir/Phoenix) | | (SOAP/HTTPS) |
+-------------------+ +------------------------+ +-------------------+
|
+----------v----------+
| OTP Supervision |
| Tree |
+----------+----------+
|
+--------------------+--------------------+
| | |
+--------v--------+ +--------v--------+ +--------v--------+
| STA.Client | | File.Worker | | Parser.Registry|
| (GenServer) | | (GenServer) | | (GenServer) |
+-----------------+ +-----------------+ +-----------------+
|
+----------v----------+
| Admin Portal |
| (Vue 3 + Vite) |
+----------+----------+
|
+----------v----------+
| Phoenix Channels |
| (WebSocket) |
+---------------------+| System | Description | Direction |
|---|---|---|
| CCS | Customer Consultation System | Inbound/Outbound |
| CIR | Credit Information Registry | Inbound |
| CMP | Means of Payment Control | Inbound |
| STR | Reserve Transfer System | Inbound/Outbound |
| SPI | Instant Payment System (PIX) | Inbound/Outbound |
| CAM | Foreign Exchange System | Inbound |
| LDL | Deferred Settlement | Inbound |
| DICT | PIX Directory | Inbound/Outbound |
# Clone the repository
git clone https://github.com/FluxiqBR/sta
cd sta
# Install dependencies
mix deps.get
# Configure environment
cp config/dev.secret.exs.example config/dev.secret.exs
nano config/dev.secret.exs # Add your credentials
# Setup database
mix ecto.setup
# Start the Phoenix server
mix phx.server
# Or start with interactive shell
iex -S mix phx.server
# Access the admin portal
open http://localhost:4000Read the full getting started guide
| Component | Technology |
|---|---|
| Backend | Elixir 1.15+, Phoenix 1.7, OTP |
| Database | PostgreSQL 15, Ecto |
| HTTP Client | Finch |
| XML Parsing | SweetXml |
| Frontend | Vue 3, Vite, Pinia |
| Real-time | Phoenix Channels (WebSocket) |
| Deployment | Docker, Kubernetes |
| Docs | VitePress |