| Índice |
|---|
Informações
Avisos
- Só são suportadas integrações no padrão REST.
- O campo "Regra de preenchimento" esclarece quais regras / validações serão aplicadas ou quais os conteúdos serão permitidos ou rejeitados. As ações descritas aqui devem ser implementadas por seus WS, evitando que os conteúdos inválidos sejam criticados pelo nosso sistema de integrações.
...
| Abreviação | Nome | Descrição |
|---|---|---|
| M | Mandatório | O preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado. |
| C | Condicional | O atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado. |
| OP | Opcional | Seu preenchimento não é obrigatório. Pode-se enviar NULL para objetos, ou arrays vazios para tipos Array |
...
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/listaDebitos
| POST | application/json | Endpoint para listar débitos relacionados ao localizador (chaveBeneficiario). |
...
| Nota | ||
|---|---|---|
| ||
No corpo da requisição serão enviadas as informações do atributo devemos enviar o objeto integração do retorno do login. Body:
|
Objetos e atributos de retorno
...
- O aplicativo irá enviar para este webservice o conteúdo dos campos tituloId e tituloCodigo retornados pelo método listaDebitos.
- O método construído por sua empresa deverá validar se a fatura existe.
- Será adicionado ao corpo da requisição as informações enviadas no atributo integracao no o objeto integracao do retorno do login.
Endpoint
Endpoint | Método | Header Content-Type | Descrição | |||||
|---|---|---|---|---|---|---|---|---|
exemplo.com/detalheDebito
| POST | application/json | Endpoint que retorna o detalhamento de um débito |
Parâmetros de entrada
...
de entrada
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu do atributo tituloCodigo do método listaDebitos |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do método listaDebitos |
...
- O aplicativo irá enviar para este webservice o conteúdo dos campos titulo e tituloCodigo, tituloId e contratoId, retornados pelo método listaDebitos.
- O método deverá validar se a fatura existe.
- O método é OPCIONAL. Implemente-o somente se desejar que seu beneficiário acesse a "ficha de compensação" dos seus débitos gerados.
- Será adicionado ao corpo da requisição as informações enviadas no atributo integracao no o objeto integracao do retorno do login.
Endpoint
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloCodigo do método listaDebitos. |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do método listaBoleto. |
...
- O aplicativo irá enviar para este webservice o conteúdo dos campos titulo e tituloCodigo, tituloId e contratoId, retornados pelo método listaBoletos.
- O método deverá validar se a fatura existe
- O método deverá retornar os eventos por beneficiário
- Este método é OPCIONAL, ou seja, não é necessário implementa-lo. Implemente-o quando sua empresa desejar exibir um detalhamento dos serviços prestados para seu contratante.
- Será adicionado ao corpo da requisição as informações enviadas no atributo integracao no o objeto integracao do retorno do login.
Endpoint
...
| Parâmetro | Obrigatório | Tipo | Descrição |
|---|---|---|---|
| integracao | M | Objeto | Informações necessárias para realizar a identificação do beneficiário no sistema. A estrutura aqui enviada será enviada no corpo das demais requisições de integração junto com os dados preenchidos pelo beneficiário no sistema. |
tituloCodigo | M | String | Código do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloCodigo do EndPoint listaDebitos |
| tituloId | OP | Integer | ID de banco de dados do titulo no seu sistema interno. O aplicativo irá enviar a mesma informação que recebeu no campo tituloId do EndPoint listaDebitos. |
...