Skip to main content

Cliente async para integracao de projetos Django com a API do CADSUS.

Project description

3s-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 three_s_cadsus_client.

Destaques

  • Cliente 100% assincrono com httpx.AsyncClient
  • Cache de token com suporte automatico ao cache do Django quando disponivel
  • Fallback para cache em memoria quando o Django nao estiver carregado
  • Autenticacao por API ou CERT
  • Metodo buscar_pessoa com deteccao automatica de CPF ou CNS
  • 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

Variaveis opcionais

export CADSUS_SYSTEM_CODE=CADSUS
export CADSUS_TIMEOUT=30
export CADSUS_CACHE_ALIAS=default
export CADSUS_CACHE_PREFIX=3s_cadsus_client
export CADSUS_TOKEN_TTL_FALLBACK=300

Uso rapido

from three_s_cadsus_client import CadSUSClient


async def consultar_cadsus(identificador: str) -> str:
    async with CadSUSClient.from_env() as client:
        resultado = await client.buscar_pessoa(identificador)
        return resultado.body

Exemplo em projeto Django

from django.http import JsonResponse

from three_s_cadsus_client import CadSUSClient


async def buscar_pessoa_view(request):
    identificador = request.GET["identificador"]

    async with CadSUSClient.from_env() as client:
        resultado = await client.buscar_pessoa(identificador)

    return JsonResponse(
        {
            "document_type": resultado.document_type.value,
            "identifier": resultado.normalized_identifier,
            "xml": resultado.body,
        }
    )

Cache de token

Quando o Django estiver disponivel e configurado, a biblioteca usa django.core.cache automaticamente. Caso contrario, usa um cache em memoria do processo.

O tempo de expiracao do token e resolvido na seguinte ordem:

  1. Campo expires_in da resposta de autenticacao
  2. Claim exp do JWT retornado
  3. 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:

  1. POST CADSUS_AUTH_LOGIN_URL com JSON {"username": "...", "password": "..."}
  2. POST CADSUS_AUTH_TOKEN_URL com header Authorization: Bearer <token-do-login>

Se a sua instalacao exigir outro formato, voce pode customizar os requests:

from three_s_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

3s_cadsus_client-0.1.0.tar.gz (10.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

3s_cadsus_client-0.1.0-py3-none-any.whl (11.2 kB view details)

Uploaded Python 3

File details

Details for the file 3s_cadsus_client-0.1.0.tar.gz.

File metadata

  • Download URL: 3s_cadsus_client-0.1.0.tar.gz
  • Upload date:
  • Size: 10.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for 3s_cadsus_client-0.1.0.tar.gz
Algorithm Hash digest
SHA256 597d475d46a05745c30d0742d0624745d30ec3baab48d864eae881af92ad0be1
MD5 294ec8cfb340419cab1a937cbba7d360
BLAKE2b-256 fa413360c3ad8227356f27bf5fa3e3595cebf0bdcdb2a71965e09fb969a6f37c

See more details on using hashes here.

Provenance

The following attestation bundles were made for 3s_cadsus_client-0.1.0.tar.gz:

Publisher: publish.yml on 3S-Saude/3s-cadsus-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file 3s_cadsus_client-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for 3s_cadsus_client-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 da58761684017d1db7ef0237c04427744e41550a7756c5443ffab440af3417bd
MD5 abf9e3ab80a6b2047bd4ca39113a7403
BLAKE2b-256 da07562877c51edcbe0341f7b77b47f59346072e3496d2212c9192d3dd12442f

See more details on using hashes here.

Provenance

The following attestation bundles were made for 3s_cadsus_client-0.1.0-py3-none-any.whl:

Publisher: publish.yml on 3S-Saude/3s-cadsus-client

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page