Webhooks
Prosperita - IT suporte@[Link]
Soluções e tecnologia financeira. [Link]
Alphaville/SP - Brazil
2 Webhooks
Webhooks
• Data de criação: 07/02/2022
• Data de atualização: 19/04/2022
• Revisão:
3 API
API
Especificações de comunicação para API.
Autenticação
A plataforma FSENGINE usa o sistema de autenticação JWT. Portanto para o consumo de
qualquer endpoint é necessario requisitar um token e envia-lo no header da requisição.
Endpoint
(POST): {URL}/api/autenticacao/token/
Payload de autenticação
{
'email': user@[Link]
'password': 123456789
}
Exemplo de requisição (header de autenticação)
{
'Authorization': Bearer __TOKEN__
}
Nota: Caso ainda não tenha usuario e senha para comunicação com a api entre em contato
com seu consultor de negocio da CM Capital.
4 Webhooks
Webhooks
Todo fluxo operacional do sistema SMART retorna notificações (via webhook) de suas operações.
Para recebê-lo favor solicitar ao setor de negócios da CM Capital configurar em seu cadastro de
operações essa funcionalidade.
Para tanto é necessário informar os seguintes dados:
INFORMAÇÃO DESCRIÇÃO
Autenticação Sistema de autenticação utilizado para receber as notificações, ( Autenticação simples via header, Token JWT)
URL/Endpoint Enpoint para o envio da notificação
Tabela de status
STATUS STEP OBJECT DESCRIÇÃO
ELIGIBILITY-QUEUED PROCESS [Link] ENVIADO PARA FILA DE ELEGIBILIDADE
ELIGIBILITY-STARTED PROCESS [Link] INICIADO PROCESSO DE ELEGIBILIDADE
APPROVAL-QUEUED PROCESS [Link] ENVIADO PARA FILA DE APROVAÇÃO
APPROVAL-STARTED PROCESS [Link] INICIADO PROCESSO DE APROVAÇÃO
WAITING-FOR-APPROVAL PROCESS [Link] AGUARDANDO APROVAÇÃO
OPERATIONS-CREATING PROCESS [Link] INICIADO PROCESSAMENTO DE OPERAÇÃO
OPERATIONS-RESULT PROCESS [Link] RESULTADO DAS OPERAÇÕES
DOCUMENTATION-QUEUED PROCESS [Link] ENVIADO PARA FILA DE DOCUMENTAÇÃO
DOCUMENTATION-STARTED PROCESS [Link] INICIADO PROCESSO DE DOCUMENTAÇÃO
DOCUMENTATION-ERROR PROCESS [Link] ERRO NO PROCESSO DE DOCUMENTAÇÃO
CERTIFICATION-QUEUED PROCESS [Link] ENVIADO PARA A FILA DE CERTIFICAÇÃO
CERTIFICATION-STARTED PROCESS [Link] INICIADO PROCESSO DE CERTIFICAÇÃO
CERTIFICATION-ERROR PROCESS [Link] ERRO NO PROCESSO DE CERTIFICAÇÃO
PAYMENT-QUEUED PROCESS [Link] ENVIADO PARA FILA DE PAGAMENTO
PAYMENT-STARTED PROCESS [Link] INICIADO PROCESSO DE PAGAMENTO
WAITING-PAYMENT PROCESS [Link] PAGAMENTO ENVIADO, AGUARDANDO RETORNO DO INSTITUIÇÃO FINANCEIRA
PAYMENT-ERROR PROCESS [Link] ERRO NO PROCESSO DE PAGAMENTO
PAYMENT-DONE PROCESS [Link] PAGAMENTO CONFIRMADO PELA INSTITUIÇÃO FINANCEIRA
DONE PROCESS [Link] PROCESSAMENTO CONCLUÍDO
5 Webhooks
Exemplo de envio
{
"step": "process",
"object": "[Link]",
"status": "operation-result",
"object_id": "1512",
"object_name": "arquivo",
"status_description": "Resultado das operações"
//este trecho somente aparece quando o 'status' for 'operation-result'
"errors": true,
"error_lines": [
{
"type": "eligibility",
"number": "1842318",
"message": "erro teste elegibilidade para webhook"
},
{
"type": "operation",
"number": "1842319",
"message": "Teste de erro webhook"
}
],
}
