Construir sua integração

Ambientes disponíveis

Ambiente	OAuth 2.0	API de garantias locatícias
Sandbox	https://auth-sandbox.morus.finance	https://api-sandbox.morus.finance/rental-insurance
Produção	https://auth.morus.finance	https://api.morus.finance/rental-insurance

Os exemplos começam pelo sandbox. Quando este portal é executado localmente, o console também oferece endereços locais editáveis. Para produção, ele gera um cURL que você pode copiar e executar em sua infraestrutura.

1. Criar uma credencial de API

Um diretor da imobiliária cria a credencial em Integrações → Chaves de API na plataforma Morus. Selecione somente as permissões necessárias para a integração. O segredo do cliente é exibido uma única vez; armazene-o em um gerenciador de segredos.

Usuários internos da Morus podem consultar e revogar credenciais, mas não podem criá-las nem revelar seus segredos.

2. Solicitar um token de acesso

Envie o ID e o segredo do cliente com autenticação HTTP Basic. O corpo da requisição usa codificação de formulário.

curl --request POST 'https://auth-sandbox.morus.finance/oauth2/token' \
  --user "$MORUS_CLIENT_ID:$MORUS_CLIENT_SECRET" \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'grant_type=client_credentials' \
  --data-urlencode 'scope=ri:rental-insurances:read'

Os tokens expiram após 15 minutos. Reutilize o token até pouco antes da expiração em vez de solicitar um novo antes de cada chamada.

3. Chamar a API de parceiros

curl 'https://api-sandbox.morus.finance/rental-insurance/v1/rental-insurances?size=20' \
  --header "Authorization: Bearer $MORUS_ACCESS_TOKEN"

Cada recurso é restrito à imobiliária proprietária da credencial. O contrato público da requisição não contém um identificador da empresa.

4. Preparar requisições de escrita

Operações de criação e alteração exigem Idempotency-Key. Atualizações de um recurso existente também exigem seu ETag atual em If-Match.

curl --request PATCH \
  'https://api-sandbox.morus.finance/rental-insurance/v1/rental-insurances/812' \
  --header "Authorization: Bearer $MORUS_ACCESS_TOKEN" \
  --header 'Content-Type: application/merge-patch+json' \
  --header 'Idempotency-Key: 9d4cba7f-7459-4cc7-86ee-4c37f7a2f17a' \
  --header 'If-Match: W/"3"' \
  --data '{"monthlyRent":2650.00}'

Continue pelo guia de idempotência ou consulte a referência de garantias locatícias.