Cliente async para integracao de projetos Django com a API do CADSUS-MS.
Project description
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:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file 3s_cadsus_client-0.1.6.tar.gz.
File metadata
- Download URL: 3s_cadsus_client-0.1.6.tar.gz
- Upload date:
- Size: 15.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6825a3df498b9acd5033a3d34880877ec6eb11466c65fe0ec94a6688dd7fb349
|
|
| MD5 |
eeec8e6da50a8310c4597db3ad5f3dd0
|
|
| BLAKE2b-256 |
1d905b772e2d1126a4dad4e8599e004afe0a313eef379ca6fab8dc7703c2d683
|
Provenance
The following attestation bundles were made for 3s_cadsus_client-0.1.6.tar.gz:
Publisher:
publish.yml on 3S-Saude/3s-cadsus-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
3s_cadsus_client-0.1.6.tar.gz -
Subject digest:
6825a3df498b9acd5033a3d34880877ec6eb11466c65fe0ec94a6688dd7fb349 - Sigstore transparency entry: 1352986086
- Sigstore integration time:
-
Permalink:
3S-Saude/3s-cadsus-client@b00e0b8ab55dccf759d3b880b7a3376af21a4f98 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/3S-Saude
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b00e0b8ab55dccf759d3b880b7a3376af21a4f98 -
Trigger Event:
pull_request
-
Statement type:
File details
Details for the file 3s_cadsus_client-0.1.6-py3-none-any.whl.
File metadata
- Download URL: 3s_cadsus_client-0.1.6-py3-none-any.whl
- Upload date:
- Size: 16.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/6.1.0 CPython/3.13.12
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
52756278f01f63922b65f901c45e09105a14370676398b8d2fa06e41a0259182
|
|
| MD5 |
062d50711d56c59a13f4d220f9b24054
|
|
| BLAKE2b-256 |
15637235c44ae07ab34108a23dc4e5f2f1a1c5823a6890f14f93ef12067ab1c1
|
Provenance
The following attestation bundles were made for 3s_cadsus_client-0.1.6-py3-none-any.whl:
Publisher:
publish.yml on 3S-Saude/3s-cadsus-client
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
3s_cadsus_client-0.1.6-py3-none-any.whl -
Subject digest:
52756278f01f63922b65f901c45e09105a14370676398b8d2fa06e41a0259182 - Sigstore transparency entry: 1352986150
- Sigstore integration time:
-
Permalink:
3S-Saude/3s-cadsus-client@b00e0b8ab55dccf759d3b880b7a3376af21a4f98 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/3S-Saude
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@b00e0b8ab55dccf759d3b880b7a3376af21a4f98 -
Trigger Event:
pull_request
-
Statement type: