As rotas de callback são exclusivas do adaptador. Não as chame de uma aplicação cliente.
Criar seu caminho de integração
- Faça o deploy das dependências do plugin, incluindo o Midaz e o adaptador de conectividade do seu ambiente.
- Obtenha um token de acesso quando a autenticação estiver habilitada e identifique a conta proprietária de cada requisição.
- Execute um fluxo público: uma chave, uma transferência ou uma cobrança.
- Mantenha o identificador da operação retornado pela requisição de criação. Leia essa operação até ela chegar a um estado terminal depois do callback do adaptador.
- Registre juntos o lançamento no Midaz e o resultado da operação.
Convenções de requisição
Use a referência de cada operação como autoridade final. Estas convenções se repetem no plugin:
Um cabeçalho de idempotência ausente ou inválido é um erro do cliente. Reutilizar uma chave com um payload diferente é uma falha de pré-condição, exceto quando você cria uma cobrança imediata ou com vencimento: essas duas rotas retornam a cobrança existente com
200.
Ler o estado depois de uma gravação assíncrona
Uma requisição bem-sucedida pode significar que o plugin aceitou o trabalho, não que o pagamento ou a cobrança externa foi concluído. No SPI, use o identificador de transferência ou devolução retornado com o endpoint de leitura de transferência ou devolução. Para cobranças, leia a cobrança pelo identificador. Trate estes resultados de forma diferente:- Erro de validação ou autorização: corrija a requisição ou o token. Não repita uma entrada inalterada.
- Resposta de replay: mantenha o resultado original. Não crie uma segunda operação de negócio.
- Conflito: leia o recurso e escolha a próxima transição permitida.
- Erro temporário de dependência: preserve o valor de idempotência antes de repetir. Uma rota que documenta uma dependência que falha de forma fechada continuará recusando a gravação até que essa dependência seja restaurada.