cadsus_client
Biblioteca Python para simplificar a interoperabilidade de projetos Django com a API do CADSUS do Ministerio da Saude.
O pacote publicado no PyPI se chama 3s-cadsus-client, enquanto o import no codigo Python e cadsus_client.
Destaques
- Cliente 100% assincrono com
httpx.AsyncClient - Cache de token usando exclusivamente
django.core.cache - Autenticacao por
APIouCERT - Metodo
buscar_pessoacom deteccao automatica de CPF ou CNS e retorno direto em JSON - Workflow de GitHub Actions pronto para build, teste e publicacao no PyPI
Instalacao
pip install 3s-cadsus-client
Configuracao por variaveis de ambiente
Metodo API
export CADSUS_AUTH_METHOD=API
export CADSUS_AUTH_LOGIN_URL=https://ses-token-api-linux.azurewebsites.net/login
export CADSUS_AUTH_TOKEN_URL=https://ses-token-api-linux.azurewebsites.net/token/osb
export CADSUS_API_URL=https://servicos.saude.gov.br/cadsus/v2/PDQSupplierJWT
export CADSUS_USER=user_cadsus
export CADSUS_PASSWORD=password_cadsus
Metodo CERT
export CADSUS_AUTH_METHOD=CERT
export CADSUS_AUTH_TOKEN_URL=https://ehr-auth.saude.gov.br/api/osb/token
export CADSUS_API_URL=https://servicos.saude.gov.br/cadsus/v2/PDQSupplierJWT
export CADSUS_CERT=/srv/app/cert.pem
export CADSUS_KEY=/srv/app/key.pem
No fluxo CERT, a biblioteca consulta CADSUS_AUTH_TOKEN_URL com GET, apresentando o certificado configurado no client TLS.
Variaveis opcionais
export CADSUS_SYSTEM_CODE=CADSUS
export CADSUS_TIMEOUT=30
export CADSUS_CACHE_ALIAS=default
export CADSUS_TOKEN_TTL_FALLBACK=300
Uso rapido
from cadsus_client import CadSUSClient
async def consultar_cadsus(identificador: str) -> dict | None:
async with CadSUSClient.from_env() as client:
return await client.buscar_pessoa(identificador)
Modo de debug
Para investigar falhas de autenticacao ou da consulta ao CADSUS, o pacote expoe buscar_pessoa_debug.
O metodo imprime no terminal:
- Variaveis usadas no fluxo
- Status do cache de token
- Requests e responses do login, do
CADSUS_AUTH_TOKEN_URLe da API do CADSUS - Excecoes levantadas durante autenticacao, consulta e parse
from cadsus_client import buscar_pessoa_debug
payload = await buscar_pessoa_debug(
"12345678901",
reveal_secrets=True,
)
Se preferir usar uma instancia ja criada do cliente:
async with CadSUSClient.from_env() as client:
payload = await client.buscar_pessoa_debug(
"12345678901",
reveal_secrets=True,
)
Use reveal_secrets=True apenas em diagnostico controlado, pois essa opcao imprime senha, tokens e headers sensiveis no stdout.
Exemplo em projeto Django
from django.http import JsonResponse
from cadsus_client import CadSUSClient
async def buscar_pessoa_view(request):
identificador = request.GET["identificador"]
async with CadSUSClient.from_env() as client:
payload = await client.buscar_pessoa(identificador)
return JsonResponse({"dados": payload})
Cache de token
A biblioteca usa exclusivamente django.core.cache para armazenar o token.
A chave utilizada no backend configurado para esse cache, incluindo Redis, e cadsus_token.
O alias do cache do Django continua configuravel por CADSUS_CACHE_ALIAS.
Nos fluxos API e CERT, o tempo de expiracao do token em cache e definido pela claim exp do JWT retornado pelo endpoint CADSUS_AUTH_TOKEN_URL.
Se o token retornado nao trouxer uma claim exp legivel, a biblioteca usa o fallback configurado por CADSUS_TOKEN_TTL_FALLBACK.
Personalizacao avancada da autenticacao API
Como a especificacao recebida nao detalha o payload exato dos dois POSTs do metodo API, a biblioteca aplica o fluxo padrao abaixo:
POST CADSUS_AUTH_LOGIN_URLcom JSON{"username": "...", "password": "..."}POST CADSUS_AUTH_TOKEN_URLcom headerAuthorization: Bearer <token-do-login>
Se a sua instalacao exigir outro formato, voce pode customizar os requests:
from cadsus_client import CadSUSClient, RequestDefinition
def build_login_request(settings):
return RequestDefinition(
method="POST",
url=settings.auth_login_url,
data={"user": settings.user, "password": settings.password},
)
def build_token_request(settings, login_token):
return RequestDefinition(
method="POST",
url=settings.auth_token_url,
headers={"Authorization": f"Bearer {login_token}"},
json={"grant_type": "client_credentials"},
)
async def consultar(identificador: str):
async with CadSUSClient.from_env(
api_login_request_factory=build_login_request,
api_token_request_factory=build_token_request,
) as client:
return await client.buscar_pessoa(identificador)
Publicacao no PyPI
O workflow em .github/workflows/publish.yml roda testes em push e pull_request, gera os artefatos do pacote e publica no PyPI quando uma tag v* e enviada.
O fluxo foi montado para usar Trusted Publishing via OIDC. Antes da primeira release, cadastre o repositrio e o workflow no PyPI:
- https://packaging.python.org/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/
- https://docs.github.com/en/actions/how-tos/secure-your-work/security-harden-deployments/oidc-in-pypi
Política de resiliência por consumidor (0.1.8)
CadSUSClient(..., http_timeout=..., token_lock=...) e from_env aceitam
um timeout HTTPX explícito, aplicado à consulta e a todas as etapas de
autenticação. token_lock é uma fábrica de context manager assíncrono;
o cache é relido sob o lock. Sem essas opções os padrões anteriores continuam
válidos. O consumidor deve limitar também o tempo total do seu caso de uso.
A versão 0.1.9 mantém a versão pública do módulo coerente com os metadados da distribuição.
Para distinguir ausência confirmada de resposta inválida, use buscar_pessoa(..., validar_resposta=True). O modo exige identidade e nome coerentes; falhas SOAP/FHIR não viram ausência. O padrão permanece compatível com consumidores existentes.
Metadata
Release files for 3s-cadsus-client 0.1.10
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| 3s_cadsus_client-0.1.10.tar.gz | 17.9 kB | With provenance | Details for 3s_cadsus_client-0.1.10.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| 3s_cadsus_client-0.1.10-py3-none-any.whl | Python 3 | none | any | Details for 3s_cadsus_client-0.1.10-py3-none-any.whl |
Total release size: 35.3 kB
Release files / 3s_cadsus_client-0.1.10.tar.gz
| Download URL | 3s_cadsus_client-0.1.10.tar.gz |
|---|---|
| Size | 17.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
2068ce3a180ca25a1838cdcfe0246ac9df228b8b87f16fbe0354c5303e808009
|
|
BLAKE2b-256 checksum How to use checksums |
0e4739c77378bbfd2f78fed061492238a5157a7d2cd9ff7f9af4d81d0cc82ae6
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logRelease files / 3s_cadsus_client-0.1.10-py3-none-any.whl
| Download URL | 3s_cadsus_client-0.1.10-py3-none-any.whl |
|---|---|
| Size | 17.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
b4cb427435f2d7495e6e652fce91bf90b8e5aedb1e55654fad91a327e1137073
|
|
BLAKE2b-256 checksum How to use checksums |
239db1a6081f54d818ed06fc103b2bd59590b46cfd48ea3f81bccac55b90b88a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.16
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logSecurity for 3s-cadsus-client 0.1.10
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for 3s_cadsus_client-0.1.10.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Nov 6, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.