XJUR Connect

Esta seção descreve como utilizar o XJUR Connect para atualizar contratos no Xjur a partir do SAP. A integração expõe um único endpoint REST que recebe os dados do SAP e aplica as alterações no Xjur.

O que esta integração faz

Ao receber uma requisição, o XJUR Connect:

Recebe a requisição de atualização com o numeroContratoSap
Localiza o ID interno do contrato via consulta ao Xjur APIM
Aplica as alterações via JSON Patch no serviço externo
Retorna o contrato atualizado

Funcionalidades principais

Funcionalidade	Descrição
Endpoint único	Um único `PUT /sap/contratos` cobre todas as atualizações
Campos opcionais	Envie apenas os campos que deseja alterar
Idempotência	Requisições repetidas com o mesmo payload retornam o resultado anterior sem reprocessamento (TTL: 24h)
Pass-through de JWT	O token informado é repassado ao serviço externo automaticamente
Erros padronizados	Todos os erros retornam `{ codigo, descricao }` com HTTP status apropriado

Pré-requisitos

Token JWT válido obtido junto ao provedor de identidade Xjur
Número do contrato no SAP (numeroContratoSap)
Acesso à rede onde a API está hospedada

Exemplo rápido

curl -X PUT https://apim-xjur-prd.xjur.com.br/connect/sap/contratos \
  -H "Authorization: Bearer <seu-token-jwt>" \
  -H "X-XJUR-SUBSCRIPTION-KEY: <sua-chave>" \
  -H "Content-Type: application/json" \
  -d '{
    "numeroContratoSap": "4500001234",
    "statusContrato": 2
  }'

Resposta de sucesso (200):

{
  "contratoId": 43754,
  "numeroContrato": "37233.001",
  "numeroContratoSap": "4500001234",
  "statusContratoId": 61,
  "dataInicioVigencia": "2026-04-23T18:14:45.405Z",
  "dataFimVigencia": "2026-04-23T18:14:45.405Z",
  "valorTotal": 1500.00,
  "valorSaldoAmortizacao": 299.22,
  "dataUltimoAtualValorAmortizacao": "2026-04-23T18:14:45.405Z",
  "dataFaturamento": "2026-04-23T18:14:45.405Z",
  "dataCadastro": "2025-07-17T09:49:12.5339504",
  "contratoParteContraria": [],
  "contratoEmpresas": [],
  "processoContratos": []
}

Próximos passos

Autenticação — como obter e enviar o token JWT
Guia de Integração — passo a passo para integrar
Referência da API — documentação interativa do endpoint
Códigos de Erro — todos os erros possíveis e como tratá-los