Versões comparadas

Versão antiga 66

changes.mady.by.user Geovane Henrique Pinto da Costa

Gravado em

comparado com

Nova versão 67

changes.mady.by.user Geovane Henrique Pinto da Costa

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice

Informações

Avisos
  1. Só são suportadas integrações no padrão REST.
  2. 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çãoNomeDescrição
MMandatórioO preenchimento do atributo é obrigatório. Caso o atributo esteja nulo ou em branco, seu "response" será rejeitado.
CCondicionalO atributo pode tornar-se obrigatório quando um ou mais atributos auxiliares for preenchido / atualizado.
OPOpcional

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

Nota
titleAtenção

O endpoint obrigatoriamente deve terminar com "/listaDebitos".


POST

application/json

Endpoint para listar débitos relacionados ao localizador (chaveBeneficiario).

...


Nota
titleAtenção


No corpo da requisição serão enviadas as informações do atributo integração do retorno do login. 

Body:

Bloco de código
{
   "integracao": {
        //Conteúdo do objeto integração.
    "<chave>": "<valor>"
  }
}



Objetos e atributos de retorno

...

Endpoint
Método
Header Content-Type
Descrição

exemplo.com/detalheDebito

Nota
titleAtenção

O endpoint obrigatoriamente deve terminar com "/detalheDebito".


POST

application/json

Endpoint que retorna o detalhamento de um débito

...

Request body

Bloco de código
{
  "integracao": {
 	 //Conteúdo do objeto integração."<chave>": "<valor>"
  },
  "tituloCodigo": "<tituloCodigo>”,
  "tituloId": "<tituloId>”
}


...

Request body

Bloco de código
{
  "integracao": {
 	 //Conteúdo do objeto integração."<chave>": "<valor>"
  },
  "tituloCodigo": "<tituloCodigo>",
  "tituloId": "<tituloId>"
}


Objetos e atributos de retorno

...

Request body

Bloco de código
{
  "integracao": {
 	 //Conteúdo do objeto integração."<chave>": "<valor>"
  },
  "tituloCodigo": "<tituloCodigo>",
  "tituloId": "<tituloId>"
}


Objetos e atributos de retorno

...