Projeto

Geral

Perfil

Editar Histórico

Manual de Integração »

Portal de Clientes - API » Histórico » Versão 2

victor.klemann, 17/05/2018 19:20 h

1 1 victor.klemann 
h1. Portal de Clientes - API
2 2 victor.klemann 





    3
    2
    victor.klemann
    
*_Observação:_* Parâmetros devem ser passados em formato *JSON*.





    4
    2
    victor.klemann
    





    5
    2
    victor.klemann
    
h2.  Títulos (_rest/portal/titulos_)





    6
    2
    victor.klemann
    





    7
    2
    victor.klemann
    
Retorna todos os títulos do cliente pesquisado.





    8
    2
    victor.klemann
    





    9
    2
    victor.klemann
    
Parâmetros:





    10
    2
    victor.klemann
    





    11
    2
    victor.klemann
    
<pre><code class="json">





    12
    2
    victor.klemann
    
{





    13
    2
    victor.klemann
    
	"user": "usuario", 





    14
    2
    victor.klemann
    
	"password": "senha", 





    15
    2
    victor.klemann
    
	"codCliente": "1234",





    16
    2
    victor.klemann
    
	"codTitulo": "1234"





    17
    2
    victor.klemann
    
}





    18
    2
    victor.klemann
    
</code></pre>





    19
    2
    victor.klemann
    





    20
    2
    victor.klemann
    
---





    21
    2
    victor.klemann
    





    22
    2
    victor.klemann
    
h2.  Dados do título (_rest/portal/titulo_)





    23
    2
    victor.klemann
    





    24
    2
    victor.klemann
    
Retorna os dados específicos do título selecionado para geração de segunda via.





    25
    2
    victor.klemann
    





    26
    2
    victor.klemann
    
Parâmetros:





    27
    2
    victor.klemann
    





    28
    2
    victor.klemann
    
<pre><code class="json">





    29
    2
    victor.klemann
    
{





    30
    2
    victor.klemann
    
	"user": "usuario", 





    31
    2
    victor.klemann
    
	"password": "senha", 





    32
    2
    victor.klemann
    
	"codDataSource": "1",





    33
    2
    victor.klemann
    
	"codCliente": "1234",





    34
    2
    victor.klemann
    
	"codTitulo": "1234"





    35
    2
    victor.klemann
    
}





    36
    2
    victor.klemann
    
</code></pre>





    37
    2
    victor.klemann
    





    38
    2
    victor.klemann
    
---





    39
    2
    victor.klemann
    





    40
    2
    victor.klemann
    
h2.  Mensagens (_rest/portal/mensagens_)





    41
    2
    victor.klemann
    





    42
    2
    victor.klemann
    
Retorna as mensagens configuradas por banco.





    43
    2
    victor.klemann
    





    44
    2
    victor.klemann
    
Parâmetros:





    45
    2
    victor.klemann
    





    46
    2
    victor.klemann
    
<pre><code class="json">





    47
    2
    victor.klemann
    
{





    48
    2
    victor.klemann
    
	"user": "usuario", 





    49
    2
    victor.klemann
    
	"password": "senha"





    50
    2
    victor.klemann
    
}





    51
    2
    victor.klemann
    
</code></pre>





    52
    2
    victor.klemann
    





    53
    2
    victor.klemann
    
---





    54
    2
    victor.klemann
    





    55
    2
    victor.klemann
    
h2.  Informações de contato (rest/portal/contato)





    56
    2
    victor.klemann
    





    57
    2
    victor.klemann
    
Retorna as informações para que o cliente possa entrar em contato. (remetente e destinatário)





    58
    2
    victor.klemann
    





    59
    2
    victor.klemann
    
Parâmetros:





    60
    2
    victor.klemann
    





    61
    2
    victor.klemann
    
<pre><code class="json">





    62
    2
    victor.klemann
    
{





    63
    2
    victor.klemann
    
	"user": "usuario", 





    64
    2
    victor.klemann
    
	"password": "senha"





    65
    2
    victor.klemann
    
}





    66
    2
    victor.klemann
    
</code></pre>





    67
    2
    victor.klemann
    





    68
    2
    victor.klemann
    
---





    69
    2
    victor.klemann
    





    70
    2
    victor.klemann
    
h2.  Enviar Extrato de títulos (rest/portal/extrato)





    71
    2
    victor.klemann
    





    72
    2
    victor.klemann
    
Envia um extrato com todos os títulos do cliente.





    73
    2
    victor.klemann
    





    74
    2
    victor.klemann
    
Parâmetros:





    75
    2
    victor.klemann
    





    76
    2
    victor.klemann
    
<pre><code class="json">





    77
    2
    victor.klemann
    
{





    78
    2
    victor.klemann
    
	"user": "usuario", 





    79
    2
    victor.klemann
    
	"password": "senha",





    80
    2
    victor.klemann
    
	"codCliente": "1234",





    81
    2
    victor.klemann
    
	"outrosDestinatarios": "teste@teste.inf.br",





    82
    2
    victor.klemann
    
	"enviaCliente": true,





    83
    2
    victor.klemann
    
	"enviaRepresentante": true,





    84
    2
    victor.klemann
    
	"receberCopia": true,





    85
    2
    victor.klemann
    
	"ordenacao": 1





    86
    2
    victor.klemann
    
}





    87
    2
    victor.klemann
    
</code></pre>





    88
    2
    victor.klemann
    





    89
    2
    victor.klemann
    
_Ordenação: 1 - Por vencimento, 2 - Por título_





    90
    2
    victor.klemann
    





    91
    2
    victor.klemann
    
---