How laddertech/sicoob-sdk works
The Sicoob Python SDK lets an application configure a client for a specific environment and credentials, then perform banking operations such as boleto management, PIX charges, and account queries. The synchronous client exposes these APIs; asynchronous client and domain modules provide a parallel route. Requests use OAuth credentials and HTTP clients to communicate with Sicoob. The README documents additional boleto workflows, including wallet movements and webhooks. Edges follow the available source references and excerpts; unsampled implementation details are not asserted.
Main entry points: api_client.py Sync HTTP client · async_client.py Async client · client.py Sync client · oauth.py OAuth authentication
Components 21
Client entry points
- Sync client
sicoob/client.py - Async client
sicoob/async_client.py
Banking operations
- Collection API
sicoob/cobranca.py - Boleto operations
sicoob/boleto.py - PIX operations
sicoob/pix.py - Account operations
sicoob/conta_corrente.py - Async boleto
sicoob/async_boleto.py - Async PIX
sicoob/async_pix.py
Auth and transport
- OAuth authentication
sicoob/auth/oauth.py - Sync HTTP client
sicoob/api_client.py - Async HTTP client
sicoob/async_client.py
Runtime support
- Environment config
sicoob/config.py - Credential validation
sicoob/_credenciais.py - Pagination
sicoob/pagination.py - Input validation
sicoob/validation.py - Retry resilience
sicoob/resilience.py - Sync cache
sicoob/cache.py - Async cache
sicoob/async_cache.py - Logging
sicoob/logging_config.py
Other components
- Application
- Sicoob API
Connections 33
- Application → Sync client: creates client
README.md - Application → Async client: uses async client
README.md - Sync client → Environment config: selects environment
sicoob/client.py - Sync client → Credential validation: validates client ID
sicoob/client.py - Sync client → OAuth authentication: initializes auth
sicoob/client.py - Sync client → Collection API: exposes collection
sicoob/client.py - Sync client → Account operations: exposes account
sicoob/client.py - Collection API → Boleto operations: creates boleto API
sicoob/cobranca.py - Collection API → PIX operations: creates PIX API
sicoob/cobranca.py - OAuth authentication → Credential validation: validates client ID
sicoob/auth/oauth.py - OAuth authentication → Sicoob API: requests access token
sicoob/auth/oauth.py - Sync HTTP client → OAuth authentication: gets access token
sicoob/api_client.py - Sync HTTP client → Environment config: uses environment
sicoob/api_client.py - Sync HTTP client → Retry resilience: creates resilient session
sicoob/api_client.py - Sync HTTP client → Sicoob API: sends HTTP requests
sicoob/api_client.py - Boleto operations → Sync HTTP client: uses API client
sicoob/boleto.py - Account operations → Sync HTTP client: uses API client
sicoob/conta_corrente.py - PIX operations → Sync HTTP client: uses API client
sicoob/pix.py - PIX operations → Pagination: fetches paged results
sicoob/pix.py - Boleto operations → Input validation: validates inputs
sicoob/boleto.py - PIX operations → Input validation: validates inputs
sicoob/pix.py - Account operations → Input validation: validates inputs
sicoob/conta_corrente.py - Async client → OAuth authentication: uses OAuth client
sicoob/async_client.py - Async client → Environment config: uses environment
sicoob/async_client.py - Async client → Credential validation: validates credentials
sicoob/async_client.py - Async client → Sicoob API: sends async requests
- Async boleto → Async client: uses async client
sicoob/async_boleto.py - Async PIX → Async client: uses async client
sicoob/async_pix.py - Async boleto → Input validation: validates inputs
sicoob/async_boleto.py - Async PIX → Input validation: validates inputs
sicoob/async_pix.py - Async cache → Sync cache: reuses cache
sicoob/async_cache.py - Sync HTTP client → Logging: logs requests
sicoob/api_client.py - OAuth authentication → Logging: logs authentication
sicoob/auth/oauth.py