NN-Agent

$ cat certificados-status-rotas.md

Certificados, status e rotas dinâmicas

mTLS, health check e métricas, e de onde vêm os dados das rotas que você criou.

POSTPUT

/certificate

Bearer

Cadastra e atualiza certificados PKCS#12 (PFX) para chamadas com mTLS. O envio é multipart/form-data, não JSON.

Entrada · multipart/form-data

  • namestringobrig.: sim

    Nome único. É o valor usado em certificateName no command POST.

  • pfxFilefileobrig.: sim

    Arquivo PFX/P12 em formato DER.

  • passwordstringobrig.: não

    Senha do arquivo PFX.

  • descriptionstringobrig.: não

    Descrição livre.

  • activebooleanobrig.: não

    Texto "true" ou "false".

  • expirationDatestringobrig.: não

    Data de expiração, como texto.

  • caCertFilefileobrig.: não

    Certificado da CA em PEM (opcional).

  • POST /certificate

    201 com o certificado (conteúdo guardado em Base64).

  • GET /certificate

    200 com a lista (204 se vazia).

  • GET /certificate/{id} · /name/{name}

    200 com o certificado. {id} é number; {name} é string.

  • PUT /certificate/{id} · /name/{name}

    200. Mesmos campos do POST; envie só o que mudou.

  • DELETE /certificate/{id}

    204.

Atenção: PFX em formato BER causa o erro "asn1: indefinite length found". Converta para DER com openssl antes de enviar.

GET

/status · /metrics

Aberto

Sem corpo e sem token. /status serve de health check; /metrics expõe métricas no formato Prometheus (text/plain).

Resposta · /status

Resposta · 200 OK
{
  "status": "UP",
  "version": "dev",
  "databases": [
    {
      "key": "MINHA_BASE",
      "status": "connected"
    }
  ]
}
  • statusstring

    Valor da variável STATUS (padrão UP).

  • versionstring

    Versão da imagem; também no header X-App-Version.

  • databasesarray

    Uma entrada por conexão: key e status.

  • status (db)enum

    connected ou disconnected (ping de 3 s).

GETPOSTPUTDELETE

/seu/caminho

Aberto

Rotas criadas com POST /router. Não exigem Bearer (proteja no gateway). Veja de onde vêm os dados que o command recebe.

Entrada · de onde vem cada parâmetro

  • path /x/{NOME}string

    Vira o parâmetro NOME (maiúsculas importam).

  • query ?a=1string

    Cada chave vira parâmetro. Só o primeiro valor é usado.

  • body application/jsonobject

    Decodificado e mesclado aos parâmetros.

  • body multipart/form-dataobject

    Até 32 MB em memória. Campos viram texto; arquivos viram nome, bytes e content-type.

  • body x-www-form-urlencodedobject

    Campos viram texto.

  • headersstring

    Repassados aos executores HTTP. X-Request-Timeout-Ms (number, ms) sobrescreve o timeout.

Resposta · o que volta

  • Consulta com linhas

    Status configurado na rota e JSON (lista, ou objeto com single-result).

  • Consulta sem linhas

    Status configurado e corpo vazio (não vira 404).

  • INSERT · UPDATE · DELETE

    Status configurado e corpo vazio.

  • PROCEDURE · ANONYMOUS

    O primeiro parâmetro OUT: objeto se for JSON válido.

  • Resposta binária (HTTP)

    O arquivo é devolvido como download, com o Content-Type original.

POST /api/suprimentos/movimentos
{
  "P_TIPO": "S",
  "P_ID_LOTE_SALDO": 1,
  "P_QUANTIDADE": 3,
  "P_ID_PACIENTE": 1,
  "P_DOCUMENTO": "REQ-001"
}
Resposta · 201 Created
{
  "idMovimento": 179,
  "saldoAtual": 126,
  "tipo": "S",
  "mensagem": "OK"
}

Fim do guia

Voltar ao início

Ir para o início →