Skip to main content

displayed_sidebar: bankingApiSidebar

Changelog

Todas as mudanças notáveis nesta API serão documentadas neste arquivo.

O formato é baseado em Keep a Changelog, e este projeto adere ao Semantic Versioning.

[Unreleased]​

Adicionado​

  • Documentação inicial da API
  • Guias de integração
  • Suporte a OAuth2 Client Credentials
  • Suporte a mTLS

[1.0.0] - 2025-01-XX​

Adicionado​

  • Endpoint POST /public/gw_banking/v1/auth/token para autenticação
  • Endpoint GET /public/gw_banking/v1/accounts/{id} para consultar conta
  • Endpoint GET /public/gw_banking/v1/accounts/{id}/balance para consultar saldo
  • Endpoint GET /public/gw_banking/v1/accounts para listar contas
  • Endpoint GET /public/gw_banking/v1/people/{id} para consultar pessoa
  • Endpoint GET /public/gw_banking/v1/people para listar pessoas
  • Padrão de erro RFC7807
  • Suporte a Correlation ID
  • Rate limiting (1000 req/min, 10000 req/hora)

Segurança​

  • Autenticação OAuth2 Client Credentials
  • Suporte a mTLS (mutual TLS)
  • Validação de JWT tokens

displayed_sidebar: bankingApiSidebar

Formato de Versão​

Este projeto usa Semantic Versioning:

  • MAJOR (X.0.0): Mudanças incompatíveis na API
  • MINOR (0.X.0): Novas funcionalidades compatíveis
  • PATCH (0.0.X): Correções de bugs compatíveis

Tipos de Mudanças​

  • Adicionado: Novas funcionalidades
  • Modificado: Mudanças em funcionalidades existentes
  • Depreciado: Funcionalidades que serão removidas
  • Removido: Funcionalidades removidas
  • Corrigido: Correções de bugs
  • Segurança: Correções de vulnerabilidades

Exemplo de Entrada​

## [1.1.0] - 2025-02-15

### Adicionado

- Novo endpoint para transferências
- Suporte a webhooks

### Modificado

- Endpoint de saldo agora retorna informações adicionais

### Corrigido

- Correção no cálculo de saldo bloqueado