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
Seção intitulada “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
Seção intitulada “Funcionalidades principais”| Funcionalidade | Descrição |
|---|---|
| Endpoint único | Um único PUT /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
Seção intitulada “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
Seção intitulada “Exemplo rápido”curl -X PUT https://apim-xjur-prd.xjur.com.br/v2/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": 789, "numeroContratoSap": "4500001234", "statusContratoId": 2, "dataAtualizacao": "2024-07-01T14:32:00Z"}Próximos passos
Seção intitulada “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