API SRO v3 — Carga de produção int_producao

Sumário

1. Visão geral
2. Fluxo operacional
3. Autenticação
4. Swagger / OpenAPI
5. Endpoints REST
6. Campos do payload
7. Respostas e erros
8. Exemplos cURL
9. Operações SQL (DDL / GET)
10. Arquivos de referência

1. Visão geral

Projeto hojeprev.root · banco HOJE_PREV. A API REST expõe inclusão unitária (add), carga em lote pós-fechamento (add_lote), cancelamento (cancel) e balancete diário (balancete_diario) na tabela dbo.int_producao, utilizada no fluxo de fechamento previdenciário para carga de produção. A carga em lote via arquivo CSV permanece fluxo interno separado (prev_fechamento_carga_int_producao). Cada registro é identificado de forma única pela combinação cpf + num_proposta.

O campo idproposta na API REST é igual a num_proposta (normalizado: UPPER, trim, máx. 30 caracteres). Use o valor retornado no add na rota de cancelamento: POST .../cancel/{idproposta} — ex.: PROP001. O cpf continua obrigatório no payload do add, mas não compõe a chave de unicidade.

2. Fluxo operacional

1. Durante o dia — enviar propostas uma a uma com POST /add. Cada inclusão usa lote automático INT_PRODUCAO_AAAA_MM_DD (ou TESTE_AAAA_MM_DD com carga_teste: true).
2. Fim do dia — consultar POST /balancete_diario (informe carga_teste: true se a carga foi de teste) para avisos e checagens.
3. Após fechar produção — enviar o arquivo completo com POST /add_lote: cabeçalho com grupo_uso, mes_referencia, lote_producao (obrigatório em produção; opcional com carga_teste: true) e array propostas[].

3. Autenticação

Todos os endpoints exigem header HTTP:

Authorization: Bearer <token_jwt>

Obter token

POST https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/login
Content-Type: application/x-www-form-urlencoded

username=<usuario>&password=<senha>&contexto=<contexto_acesso>

O token retornado em engine_data.token (ou estrutura equivalente do login) deve ser enviado nas chamadas à API int_producao.

4. Swagger / OpenAPI

A API está documentada no Swagger UI do dotnet_bke (Swashbuckle), grupo api_int_producao, rótulo Carga int_producao.

Como testar no Swagger UI

1. Abra https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/swagger.
2. No combo superior, selecione Carga int_producao.
3. Clique em Authorize e informe Bearer <token_jwt> (token do login).
4. Expanda POST .../add, POST .../add_lote, POST .../cancel ou POST .../balancete_diario, preencha o JSON e execute Try it out.

O schema do body de add corresponde a dotnet_bke.model_engine.TSroV3IntProducaoIn; cancel usa rota POST .../cancel/{idproposta} com body TSroV3IntProducaoCancelIn (somente observacao); balancete_diario usa TSroV3IntProducaoBalanceteDiarioIn (grupo_uso obrigatório; dt_carga opcional); add_lote usa TSroV3IntProducaoAddLoteIn (cabeçalho + propostas[]).

5. Endpoints REST

6. Campos do payload (JSON)

6.1 Campos do add (proposta unitária)

* Obrigatório no add. A unicidade é por num_proposta (idproposta = num_proposta).

6.2 Campos do add_lote (cabeçalho + array)

* lote_producao obrigatório em carga de produção; com carga_teste: true pode ser omitido (gerado) ou informado com prefixo TESTE_.

Payload do cancel (somente estes campos)

7. Respostas, normalização e checagens

Normalização automática (ADD)

Antes de gravar, a procedure aplica os mesmos tratamentos de prev_fechamento_carga_int_producao:

• num_proposta — fn_limpa_num_proposta, UPPER, trim, max 30; chave primária e valor de idproposta
• cpf — zero-fill 11 dígitos; dado cadastral (não compõe a chave)
• cod_plano — sempre 01 (campo interno; retornado no GET SQL)
• tipo_averbacao — valor livre; UPPER + remove_acento, max 30 (enviar sem acentos)
• vl_produto — fixo 20.00 (campo interno)
• email — obrigatório; UPPER, remove espaços e aspas; formato inválido marca EMAIL_INVALIDO em checagem_erro (não rejeita o add)
• lote_producao — INT_PRODUCAO_AAAA_MM_DD (produção) ou TESTE_AAAA_MM_DD (carga_teste: true); coluna arquivo
• dt_interface — dd/MM/yyyy; default: data de hoje (sem componente de hora)
• Datas — formato dd/MM/yyyy; inválidas retornam erro antes do INSERT
• grupo_uso — obrigatório; chave em cproc_config para fechamento (ex.: HOJEPREV)
• fechamento_mensal_mes_aberto, int_producao_mes_emissao_propostas, int_producao_mes_vigencia_propostas — sempre FECHAMENTO_MENSAL_MES_ABERTO do grupo (não parametrizáveis)
• cod_produtor — opcional; omitir ou vazio → gravado como NULL
• mes_referencia — obrigatório; validado no mesmo mês/ano do fechamento aberto

Controle da carga do dia

Todos os add do mesmo dia compartilham o mesmo lote (lote_producao / coluna arquivo = INT_PRODUCAO_AAAA_MM_DD). Regras de checagem alinhadas à carga interna:

• cod_plano fixo 01 em toda carga REST (não parametrizável).
• fechamento_mensal_mes_aberto é definido internamente via cproc_config (não enviado pelo cliente).
• Após cada inclusão, rodam as 5 checagens pós-gravação do lote sobre todo o arquivo do dia.

Checagens pós-gravação (checagem_erro)

checagem_erro e carga_anterior não são parâmetros de entrada — controlados pela API (carga_anterior sempre N; checagens abaixo preenchem checagem_erro na resposta do add).

Idênticas a prev_fechamento_carga_int_producao (UPDATE por arquivo). O registro retorna engine_status: ok; problemas ficam em checagem_erro. Nenhuma checagem rejeita o add.

Respostas JSON

Exemplo — sucesso ADD

{
  "engine_status": "ok",
  "idproposta": "PROP001",
  "cpf": "12345678901",
  "num_proposta": "PROP001",
  "lote_producao": "INT_PRODUCAO_2026_06_16",
  "checagem_erro": null,
  "dt_processamento_carga": "2026-06-16 14:23:11",
  "qtd_add": 42,
  "qtd_cancel": 3,
  "qtd_ativos": 39
}

Exemplo — sucesso ADD_LOTE

{
  "engine_status": "ok",
  "lote_producao": "INT_PRODUCAO_2026_06_16",
  "mes_referencia": "01/06/2026",
  "dt_interface": "16/06/2026",
  "qtd_propostas": 2,
  "qtd_ok": 2,
  "qtd_erro": 0,
  "qtd_add": 2,
  "qtd_cancel": 0,
  "qtd_ativos": 2,
  "propostas": [
    { "seq": 1, "cpf": "12345678901", "num_proposta": "PROP001",
      "idproposta": "PROP001", "engine_status": "ok", "checagem_erro": null }
  ]
}

Exemplo — sucesso BALANCETE_DIARIO

{
  "engine_status": "ok",
  "lote_producao": "INT_PRODUCAO_2026_06_16",
  "dt_carga": "16/06/2026",
  "qtd_add": 42,
  "qtd_cancel": 3,
  "qtd_ativos": 39,
  "qtd_problemas": 2,
  "balancete": [
    { "checagem_erro": "OK", "qtd": 37 },
    { "checagem_erro": "EMAIL_INVALIDO", "qtd": 2 }
  ]
}

Exemplo — sucesso com alerta de checagem

{
  "engine_status": "ok",
  "idproposta": "PROP001",
  "checagem_erro": "VL_CONTRIB_MAIOR_QUE_20"
}

Exemplo — GET mes_referencia_atual

{
  "engine_status": "ok",
  "grupo_uso": "HOJEPREV",
  "fechamento_mensal_mes_aberto": "01/06/2026",
  "int_producao_mes_emissao_propostas": "01/06/2026",
  "int_producao_mes_vigencia_propostas": "01/06/2026",
  "mes_referencia_atual": "01/06/2026"
}

Exemplo — erro de negócio (pré-gravação)

{
  "engine_status": "erro",
  "engine_message": "Registro ja existe (num_proposta)"
}

Códigos HTTP do controller

• 200 OK — execução SQL sem exceção.
• 401 Unauthorized — token ausente, expirado ou role insuficiente.
• 500 Internal Server Error — exceção no backend ou erro SQL reportado por eng_sql.

8. Exemplos cURL

8.1 Mes referencia atual (GET)

curl -s -X GET "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/api_int_producao/mes_referencia_atual?grupo_uso=HOJEPREV" \
  -H "Authorization: Bearer <TOKEN>"

8.2 Login

curl -s -X POST "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/login" \
  -H "Content-Type: application/x-www-form-urlencoded" \
  -d "username=integracao&password=***&contexto=HOJEPREV"

8.3 Inclusão de teste (ADD + carga_teste)

curl -s -X POST "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/api_int_producao/add" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "grupo_uso": "HOJEPREV",
    "carga_teste": true,
    "cpf": "12345678901",
    "num_proposta": "PROPTEST001",
    "mes_referencia": "01/06/2026",
    "dt_proposta": "15/06/2026",
    "nome": "JOAO DA SILVA",
    "dt_nasc": "01/01/1980",
    "rg": "MG1234567",
    "rg_dt": "01/01/2000",
    "rg_org": "SSP-MG",
    "endereco": "RUA EXEMPLO 100",
    "bairro": "CENTRO",
    "telefone": "31999999999",
    "cidade": "BELO HORIZONTE",
    "estado": "MG",
    "cep": "30100000",
    "sexo": "M",
    "estado_civil": "C",
    "email": "JOAO@EXEMPLO.COM.BR",
    "matricula": "123456",
    "tipo_averbacao": "NOVA",
    "codorgao": "ORG01",
    "nomeorgao": "ORGAO EXEMPLO",
    "codupag": "UP01",
    "nomeupag": "UPAG EXEMPLO",
    "uf_upag": "MG"
  }'

Resposta inclui "lote_producao": "TESTE_2026_06_16" (data do processamento).

8.4 Inclusão (ADD)

curl -s -X POST "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/api_int_producao/add" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "grupo_uso": "HOJEPREV",
    "cpf": "12345678901",
    "num_proposta": "PROP001",
    "mes_referencia": "01/06/2026",
    "dt_proposta": "15/06/2026",
    "nome": "JOAO DA SILVA",
    "dt_nasc": "01/01/1980",
    "rg": "MG1234567",
    "rg_dt": "01/01/2000",
    "rg_org": "SSP-MG",
    "endereco": "RUA EXEMPLO 100",
    "bairro": "CENTRO",
    "telefone": "31999999999",
    "cidade": "BELO HORIZONTE",
    "estado": "MG",
    "cep": "30100000",
    "sexo": "M",
    "estado_civil": "C",
    "email": "JOAO@EXEMPLO.COM.BR",
    "matricula": "123456",
    "tipo_averbacao": "NOVA",
    "codorgao": "ORG01",
    "nomeorgao": "ORGAO EXEMPLO",
    "codupag": "UP01",
    "nomeupag": "UPAG EXEMPLO",
    "uf_upag": "MG"
  }'

8.5 Carga em lote (ADD_LOTE)

curl -s -X POST "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/api_int_producao/add_lote" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "grupo_uso": "HOJEPREV",
    "mes_referencia": "01/06/2026",
    "dt_interface": "16/06/2026",
    "lote_producao": "INT_PRODUCAO_2026_06_16",
    "propostas": [
      {
        "cpf": "12345678901",
        "num_proposta": "PROP001",
        "dt_proposta": "15/06/2026",
        "nome": "JOAO DA SILVA",
        "dt_nasc": "01/01/1980",
        "rg": "MG1234567",
        "rg_dt": "01/01/2000",
        "rg_org": "SSP-MG",
        "endereco": "RUA EXEMPLO 100",
        "bairro": "CENTRO",
        "telefone": "31999999999",
        "cidade": "BELO HORIZONTE",
        "estado": "MG",
        "cep": "30100000",
        "sexo": "M",
        "estado_civil": "C",
        "email": "JOAO@EXEMPLO.COM.BR",
        "matricula": "123456",
        "tipo_averbacao": "NOVA",
        "codorgao": "ORG01",
        "nomeorgao": "ORGAO EXEMPLO",
        "codupag": "UP01",
        "nomeupag": "UPAG EXEMPLO",
        "uf_upag": "MG"
      }
    ]
  }'

8.6 Cancelamento (CANCEL)

curl -s -X POST "https://hojeprevidencia-ww1.dynv6.net/dotnet_bke/api_int_producao/cancel/PROP001" \
  -H "Authorization: Bearer <TOKEN>" \
  -H "Content-Type: application/json" \
  -d '{
    "observacao": "Cliente desistiu da proposta"
  }'

Exemplo — sucesso CANCEL

{
  "engine_status": "ok",
  "idproposta": "PROP001",
  "cpf": "12345678901",
  "num_proposta": "PROP001",
  "checagem_erro": "CANCELADO - Cliente desistiu da proposta",
  "dt_processamento_carga": "2026-06-16 15:40:02",
  "engine_message": "cancelado"
}

9. Operações SQL (procedure)

Para DBAs e testes diretos no SQL Server. O REST usa internamente OPERACAO = ADD, ADD_LOTE ou CANCEL.

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"DDL"}';

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"GET_MES_REFERENCIA","grupo_uso":"HOJEPREV"}';

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"BALANCETE_DIARIO","grupo_uso":"HOJEPREV","dt_carga":"16/06/2026"}';

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"ADD_LOTE","grupo_uso":"HOJEPREV","mes_referencia":"01/06/2026","lote_producao":"INT_PRODUCAO_2026_06_16","propostas":[{"cpf":"12345678901","num_proposta":"PROP001","dt_proposta":"15/06/2026","nome":"JOAO DA SILVA","dt_nasc":"01/01/1980","rg":"MG1234567","rg_dt":"01/01/2000","rg_org":"SSP-MG","endereco":"RUA EXEMPLO 100","bairro":"CENTRO","telefone":"31999999999","cidade":"BELO HORIZONTE","estado":"MG","cep":"30100000","sexo":"M","estado_civil":"C","email":"JOAO@EXEMPLO.COM.BR","matricula":"123456","tipo_averbacao":"NOVA","codorgao":"ORG01","nomeorgao":"ORGAO EXEMPLO","codupag":"UP01","nomeupag":"UPAG EXEMPLO","uf_upag":"MG"}]}';

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"CANCEL","idproposta":"PROP001","observacao":"Cliente desistiu"}';

EXEC dbo.sro_v3_int_producao_api
  @__json_data = N'{"OPERACAO":"GET","num_proposta":"PROP001"}';

10. Arquivos de referência no repositório