Consumidor

Acesso REST - Credenciada Fornecedor

Para integrar o seu sistema ao Consumidor.gov.br, foi criado um Webservice REST referente a todas as operações já disponíveis na parte web do sistema. Com estes serviços você poderá consultar suas reclamações, detalhá-las, respondê-las, dentre outras ações. Existem quatro passos necessários para que você possa acessar estes serviços:

Acessar o cadastro da sua credenciada e habilitar o acesso, gerando assim suas credenciais. Elas são intransferíveis e proverá os acessos aos recursos. Caso não tenha essa opção, contate a Senacon para habilitar o uso da API.
No seu sistema, com posse das credenciais, você deve autenticar-se por um Token temporário, análogo a uma sessão de acesso. Este Token será válido durante 1 dia corrido, e expirará sempre às 23:59:59hs desse dia.
Com o Token em mãos, acesse o serviço necessário para a sua regra.

Caso queira fazer o teste em nosso servidor de treinamento, baixe este zip com um XML de importação do SOAP-UI. Com ele você poderá testar a rede e caso retorne validação de autenticação. Os mesmos testes podem ser feitos via cURL normalmente.

Para todos os serviços (exceto o recurso de Segurança/Autenticação), será obrigatório passar o Token de autorização no cabeçalho da requisição, bem como a versão do sistema como parâmetro da requisição.

Na tabela de dados de cada serviço, podem existir três tipos de parâmetros de envio:

Parâmetro de Header: dado a ser inserido no cabeçalho da requisição, como o Token.
Parâmetro de Request: dado como parâmetro query da requisição. Ex, caso GET '/api/servico/reclamacoes/listar?dado=9999', caso POST, dentro do corpo.
Parâmetro de URL: dado inserido direto na URL, em local específico. Ex: '/api/servico/reclamacao/9999/detalhe'.

Este manual é indicado para desenvolvedores. Abaixo segue a lista dos serviços disponíveis.

Abaixo temos os ambientes. Nas URLs a indicação {url-ambiente}, troque conforme um dos ambientes abaixo:

URL de Produção: https://api.consumidor.gov.br/api/servico

URL de Treinamento: https://api-treinamento.consumidor.gov.br/api/servico

Versão Atual: 1.0 (BETA)

Disponibilidade: das 3:00hs até 7:59hs e de 12:00hs até 13:59hs, acesso livre. Fora dessa faixa, acesso limitado.

Segurança:

Autenticação e Geração do Token

O que é

Passo inicial para acessar a qualquer outro recurso, retorna um Token temporário onde deve ser inserido no cabeçalho da requisição nos demais serviços. Sem o Token, ocorrerá validação de segurança.

Utiliza o padrão OAuth2. Assim os dados devem estar nos parâmetros da requisição, caso não esteja utilizando uma API de cliente OAuth. Este recurso não exige o parâmetro de versão.

IMPORTANTE: o content-type especificamente desda url de autenticação é 'application/x-www-form-urlencoded', não json, apesar de ser POST.

URL: {url-ambiente}/seguranca/empresa/token

Método HTTP: POST.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/x-www-form-urlencoded;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
client_id	Texto	Sim	ID da Credenciada. Pode ser visto na tela de edição da sua credenciada.
code	Texto	Sim	Código de Autenticação. Pode ser visto na tela de edição da sua credenciada.
client_secret	Texto	Sim	Senha de Autenticação. Pode ser visto na tela de edição da sua credenciada.
grant_type	Texto	Sim	Tipo de solicitação ao servidor oAuth. Padrão: 'client_credentials'.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
access_token	Texto	Sim	Token temporário da credenciada. Deve ser utilizado nos demais acessos.
expires_in	Numérico	Sim	Tempo em segundos que o Token irá expirar.

Exemplo de Resposta

{  
   "expires_in":111600,
   "access_token":"b895ec3c0e14d76967b564e2fa795862"
}

Consultas de Reclamações:

Listagem de Reclamações

O que é

Serviço que retorna a listagem de reclamações com filtragem dos dados. Os parâmetros de filtragem são opcionais, e por isso, devem ser passados como parâmetros da requisição, podendo ser omitidos caso não sejam utilizados.

Para os campos de código do filtro, há serviços de cadastros básicos que obtém as listas com código e descrição, para preenchimento desses campos.

URL: {url-ambiente}/reclamacoes/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Não	Número do protocolo, que identifica uma única reclamação.
codigoTipoTramiteReclamacao	Numérico	Não	Código de um tipo de trâmite das reclamações.
codigoSituacaoReclamacao	Numérico	Não	Código de uma situação das reclamações.
numAvaliacao	Numérico	Não	Valor da avaliação do consumidor. Válidos: 1 a 3, sendo: Resolvida Não Resolvida Não Avaliada
nomeReclamante	Texto	Não	Nome do reclamante das reclamações. Assume prefixos e sufixos. Por exemplo, com 'João' poderá retornar 'João Paulo' e 'Antônio João'.
cpfReclamante	Numérico	Não	CPF do reclamante das reclamações. Somente os números.
siglaRegiao	Texto	Não	Sigla da região dos endereços das reclamações.
siglaUF	Texto	Não	Sigla do estado dos endereços das reclamações. Ex: PA, SP, MS, DF.
codigoMunicipio	Numérico	Não	Código do município dos endereços das reclamações.
situacaoVinculo	Numérico	Não	Código da situação do vínculo das reclamações.
codigoGrupoEconomico	Numérico	Não	Código do grupo ecônomico do fornecedor das reclamações.
codigoMeioConsumo	Numérico	Não	Código do meio de consumo (campo 'Como Comprou/Contratou').
codigoArea	Numérico	Não	Código da área das reclamações.
codigoAssunto	Numérico	Não	Código do assunto relacionado com a área.
codigoProblema	Numérico	Não	Código do problema relacionado com o assunto.
notaConsumidor	Numérico	Não	Valor da nota que o consumidor deu para as reclamações. Válidos: 1 a 5.
textoReferenciaFornecedor	Texto	Não	Texto livre de referência nas reclamações.
dataIniPrazo	Texto	Não	Data inicial do prazo das reclamações, no formato 'dd-MM-yyyy'. Não há opção com horas. É obrigatório caso a data final do prazo for preenchida.
dataFimPrazo	Texto	Não	Data final do prazo das reclamações, no formato 'dd-MM-yyyy'. Não há opção com horas. É obrigatório caso a data inicial do prazo for preenchida.
dataIniPeriodo	Texto	Não	Data inicial da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data final for preenchida.
horaInicialPeriodo	Texto	Não	Hora referente a data inicial da abertura das reclamações, no formato 'HH:mm:ss'. Caso não preenchida assumirá '00:00:00'.
dataFimPeriodo	Texto	Não	Data final da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data inicial for preenchida.
horaFinalPeriodo	Texto	Não	Hora referente a data final da abertura das reclamações, no formato 'HH:mm:ss'. Caso não preenchida assumirá '23:59:59'.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
protocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
situacao	Objeto	Sim	Código e Descrição de uma situação das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
prazo	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
dataAbertura	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
reclamante	Objeto	Sim	Dados básicos do reclamente, com nome e CPF. Para mais dados, deve-se consultar os detalhes da reclamação.
acoes	Lista	Sim	Ações disponíveis para cada objeto, facilitando avanços em fluxos ou consultar dados. Somente estarão disponíveis os links para ações condizentes com regras de situação e fluxo de cada reclamação.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "protocolo":20140100000091189,
         "situacao":{  
            "codigo":7,
            "descricao":"Finalizada não avaliada"
         },
         "prazo":"10/06/2014 00:00:00",
         "dataAbertura":"10/05/2014 11:22:05",
         "reclamante":{  
            "nome":"Nome do Reclamado",
            "documento":00100200344
         },
         "acoes":[  
            {  
               "rel":"detalhar", "href":"{url-ambiente}/reclamacao/20140100000091189/detalhe",
               "type":"application/json", "method":"GET"
            },
            {  
               "rel":"complementar", "href":"{url-ambiente}/reclamacao/20140100000091189/complementar",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"responder", "href":"{url-ambiente}/reclamacao/20140100000091189/responder",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"analise_procon", "href":"{url-ambiente}/reclamacao/20140100000091189/recusar",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"redirecionar", "href":"{url-ambiente}/reclamacao/20140100000091189/redirecionar",
               "type":"application/json", "method":"POST"
            }
         ]
      }
   ]
}

Listagem de Reclamações Paginada

O que é

Serviço que retorna a listagem de reclamações com filtragem dos dados de forma paginada. Os parâmetros de filtragem são opcionais, e por isso, devem ser passados como parâmetros da requisição, podendo ser omitidos caso não sejam utilizados.

Para os campos de código do filtro, há serviços de cadastros básicos que obtém as listas com código e descrição, para preenchimento desses campos.

URL: {url-ambiente}/reclamacoes/listar/paginado

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
page	Numérico	Sim	Página da lista que deseja retornar. Página inicial sempre será a 0.
size	Numérico	Não	Define o número de registros que serão exibidos por página da consulta. Este parâmetro é opcional e, se não for informado, o valor padrão será 50. O usuário pode informar um valor para "size" entre 1 e 100. Se o usuário informar um valor maior que 100, a API irá definir o valor de "size" como 100 automaticamente.
numeroProtocolo	Numérico	Não	Número do protocolo, que identifica uma única reclamação.
codigoTipoTramiteReclamacao	Numérico	Não	Código de um tipo de trâmite das reclamações.
codigoSituacaoReclamacao	Numérico	Não	Código de uma situação das reclamações.
numAvaliacao	Numérico	Não	Valor da avaliação do consumidor. Válidos: 1 a 3, sendo: Resolvida Não Resolvida Não Avaliada
nomeReclamante	Texto	Não	Nome do reclamante das reclamações. Assume prefixos e sufixos. Por exemplo, com 'João' poderá retornar 'João Paulo' e 'Antônio João'.
cpfReclamante	Numérico	Não	CPF do reclamante das reclamações. Somente os números.
siglaRegiao	Texto	Não	Sigla da região dos endereços das reclamações.
siglaUF	Texto	Não	Sigla do estado dos endereços das reclamações. Ex: PA, SP, MS, DF.
codigoMunicipio	Numérico	Não	Código do município dos endereços das reclamações.
situacaoVinculo	Numérico	Não	Código da situação do vínculo das reclamações.
codigoGrupoEconomico	Numérico	Não	Código do grupo ecônomico do fornecedor das reclamações.
codigoMeioConsumo	Numérico	Não	Código do meio de consumo (campo 'Como Comprou/Contratou').
codigoArea	Numérico	Não	Código da área das reclamações.
codigoAssunto	Numérico	Não	Código do assunto relacionado com a área.
codigoProblema	Numérico	Não	Código do problema relacionado com o assunto.
notaConsumidor	Numérico	Não	Valor da nota que o consumidor deu para as reclamações. Válidos: 1 a 5.
textoReferenciaFornecedor	Texto	Não	Texto livre de referência nas reclamações.
dataIniPrazo	Texto	Não	Data inicial do prazo das reclamações, no formato 'dd-MM-yyyy'. Não há opção com horas. É obrigatório caso a data final do prazo for preenchida.
dataFimPrazo	Texto	Não	Data final do prazo das reclamações, no formato 'dd-MM-yyyy'. Não há opção com horas. É obrigatório caso a data inicial do prazo for preenchida.
dataIniPeriodo	Texto	Não	Data inicial da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data final for preenchida.
horaInicialPeriodo	Texto	Não	Hora referente a data inicial da abertura das reclamações, no formato 'HH:mm:ss'. Caso não preenchida assumirá '00:00:00'.
dataFimPeriodo	Texto	Não	Data final da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data inicial for preenchida.
horaFinalPeriodo	Texto	Não	Hora referente a data final da abertura das reclamações, no formato 'HH:mm:ss'. Caso não preenchida assumirá '23:59:59'.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro do Objeto de Dado

Campo	Formato	Obrigatório	Descrição
content	Lista	Sim	Lista com o conteúdo da página requisitada.
size	Numérico	Sim	Número de resultados por página que foi informando na requisição. Valor padrão 50.
number	Numérico	Sim	Número da página atual.
sort	Numérico	Não	Não utilizado, valor sempre nulo.
totalElements	Numérico	Sim	Número total de elementos.
numberOfElements	Numérico	Sim	Número total de elementos na página atual.
firstPage	Booleano	Sim	Indica se é primeira página da lista de resultados.
lastPage	Booleano	Sim	Indica se é última página da lista de resultados.
totalPages	Numérico	Sim	Número total de páginas da requisição.

Campos dentro da Lista de Conteúdo

Campo	Formato	Obrigatório	Descrição
protocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
situacao	Objeto	Sim	Código e Descrição de uma situação das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
prazo	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
dataAbertura	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
reclamante	Objeto	Sim	Dados básicos do reclamente, com nome e CPF. Para mais dados, deve-se consultar os detalhes da reclamação.
acoes	Lista	Sim	Ações disponíveis para cada objeto, facilitando avanços em fluxos ou consultar dados. Somente estarão disponíveis os links para ações condizentes com regras de situação e fluxo de cada reclamação.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
        "content":[
          {
             "protocolo":20140100000091189,
             "situacao":{
                "codigo":7,
                "descricao":"Finalizada não avaliada"
             },
             "prazo":"10/06/2014 00:00:00",
             "dataAbertura":"10/05/2014 11:22:05",
             "reclamante":{
                "nome":"Nome do Reclamado",
                "documento":00100200344
             },
             "acoes":[
                {
                   "rel":"detalhar", "href":"{url-ambiente}/reclamacao/20140100000091189/detalhe",
                   "type":"application/json", "method":"GET"
                },
                {
                   "rel":"complementar", "href":"{url-ambiente}/reclamacao/20140100000091189/complementar",
                   "type":"application/json", "method":"POST"
                },
                {
                   "rel":"responder", "href":"{url-ambiente}/reclamacao/20140100000091189/responder",
                   "type":"application/json", "method":"POST"
                },
                {
                   "rel":"analise_procon", "href":"{url-ambiente}/reclamacao/20140100000091189/recusar",
                   "type":"application/json", "method":"POST"
                },
                {
                   "rel":"redirecionar", "href":"{url-ambiente}/reclamacao/20140100000091189/redirecionar",
                   "type":"application/json", "method":"POST"
                }
             ]
      "sort":null,
      "totalElements":1,
      "totalPages":1,
      "numberOfElements":1,
      "firstPage":true,
      "lastPage":true,
      "size":50,
      "number":0
      }
   ]
}

Detalhe da Reclamação

O que é

Serviço que retorna os detalhes de uma única reclamação. Serão retornados os dados dos trâmites e as informações sobre o consumidor e o gestor da reclamação. Os anexos dos trâmites estarão sem os bytes do arquivo, sendo necessário acesso a outro recurso para baixar os bytes.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/detalhe

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dado	Objeto	Não	Valores do dado retornado (somente um objeto). Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro do Objeto de Dado

Campo	Formato	Obrigatório	Descrição
protocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
situacao	Objeto	Sim	Código e Descrição de uma situação das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
meioConsumo	Objeto	Sim	Código e Descrição de um meio de consumo das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
prazo	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
dataAbertura	Texto	Sim	Formato 'dd/MM/yyyy HH:mm:ss'.
area	Objeto	Sim	Código e Descrição de uma área das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
assunto	Objeto	Sim	Código e Descrição de um assunto das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
problema	Objeto	Sim	Código e Descrição de um problema das reclamações. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
reclamante	Objeto	Sim	Detalhes do reclamante, com documento, endereço, emails e telefones, mas sem número de identificação. Os tipos de telefones podem ser: Residencial. Celular. Comercial. Público. . Os tipos de emails podem ser: Pessoal. Institucional. Fale Conosco. Notificação. Público.
reclamado	Objeto	Sim	Detalhes do reclamado, com documento e endereço.
mediador	Objeto	Sim	Detalhes do mediador, com documento e endereço.
tramites	Lista	Sim	Tramites da reclamação, com data, tipo, autor, textos e anexos (sem bytes, mas com um link para facilitar o download dos bytes). Os tipos serão retornados com código e sua descrição, mas como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
acoes	Lista	Sim	Ações disponíveis para cada objeto, facilitando avanços em fluxos ou consultar dados. Somente estarão disponíveis os links para ações condizentes com regras de situação e fluxo de cada reclamação.

Exemplo de Resposta

{  
   "dado":{  
      "protocolo":20140700000001189,
      "situacao":{  
         "codigo":7,
         "descricao":"Finalizada não avaliada"
      },
      "meioConsumo":{  
         "codigo":5,
         "descricao":"Domicílio"
      },
      "prazo":"06/11/2077 00:00:00",
      "dataAbertura":"29/07/2014 15:43:39",
      "area":{  
         "codigo":3,
         "descricao":"Serviços Financeiros"
      },
      "assunto":{  
         "codigo":301,
         "descricao":"Cartão de Crédito / Cartão de Débito / Cartão de Loja"
      },
      "problema":{  
         "codigo":10000031,
         "descricao":"Cobrança submetendo a ofensa, constrangimento ou ameaça"
      },
      "reclamante":{  
         "nome":"Nome do Reclamante",
         "dataNascimento":"10/10/1990",
         "documento":00100200344,
         "emails":[  
            {  
               "email":"reclamante@gmail.com",
               "principal":true,
               "tipo":"Pessoal"
            }
         ],
         "telefones":[  
            {  
               "ddd":"21",
               "telefone":"29853751",
               "tipo":1
            }
         ],
         "estado":"RJ",
         "cidade":"Rio de Janeiro",
         "logradouro":"Avenida das Américas",
         "bairro":"Barra da Tijuca",
         "numeroComplemento":"Edificio Sede - 5 Andar - Sala 524"
      },
      "reclamado":{  
         "nome":"Bradesco Capitalização S.A.",
         "numeroIdentificacao":20140206000001110,
         "documento":85766474000100,
         "estado":"SP",
         "cidade":"São Paulo",
         "logradouro":"Avenida Paulista 1415",
         "bairro":"Bela Vista",
         "numeroComplemento":"4 andar NR 1415"
      },
      "mediador":{  
         "nome":"Procon Estadual RJ",
         "numeroIdentificacao":20140102000000560,
         "documento":55766474000105,
         "estado":"RJ",
         "cidade":"Rio de Janeiro",
         "logradouro":"Rua Gustavo de Lacerda",
         "bairro":"Centro",
         "numeroComplemento":"102"
      },
      "tramites":[
         {  
            "tipo":{  
               "codigo":1,
               "descricao":"Abertura da reclamação"
            },
            "data":"08/01/2014 10:31:21",
            "codigo":1,
            "autor":"Nome do Reclamante",
            "textos":[  
               {  
                  "texto":"N",
                  "tipo":{  
                    "codigo":1,
                    "descricao":"Indicador de Contato com o Fornecedor"
                  }
               },
               {  
                  "texto":"Texto que o consumidor digita sobre a reclamação",
                  "tipo":{  
                    "codigo":3,
                    "descricao":"Descrição da reclamação"
                  }
               },
               {  
                  "texto":"Texto que o consumidor digita sobre o pedido",
                  "tipo":{  
                    "codigo":4,
                    "descricao":"Pedido da reclamação"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":2,
               "descricao":"Recebido pelo fornecedor"
            },
            "data":"09/01/2014 10:32:51",
            "codigo":2,
            "autor":"Bradesco Capitalização",
            "textos":[  
               {  
                  "texto":"(Sem Detalhes)",
                  "tipo":{  
                    "codigo":9,
                    "descricao":"Texto do Sistema"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":3,
               "descricao":"Complemento da reclamação"
            },
            "data":"09/01/2014 12:23:37",
            "codigo":3,
            "autor":"Bradesco Capitalização",
            "textos":[  
               {  
                  "texto":"Texto digitado pelo fornecedor",
                  "tipo":{  
                    "codigo":5,
                    "descricao":"Interação Única"
                  }
               }
            ],
            "anexos":[  
               {  
                  "codigo":1,
                  "nome":"comprovante.jpg",
                  "tamanho":879394,
                  "acao":{  
                     "rel":"baixar_anexo", "href":"{url-ambiente}/reclamacao/20140100000091189/tramite/3/anexo/1/baixar", "type":"application/json", "method":"GET"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":4,
               "descricao":"Redirecionamento da reclamação"
            },
            "data":"10/01/2014 15:46:45",
            "codigo":4,
            "autor":"Bradesco Capitalização",
            "textos":[  
               {  
                  "texto":"Texto digitado pelo fornecedor",
                  "tipo":{  
                    "codigo":5,
                    "descricao":"Interação Única"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":4,
               "descricao":"Redirecionamento da reclamação"
            },
            "data":"10/01/2014 15:47:01",
            "codigo":5,
            "autor":"Bradesco",
            "textos":[  
               {  
                  "texto":"Texto digitado pelo fornecedor",
                  "tipo":{  
                    "codigo":5,
                    "descricao":"Interação Única"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":5,
               "descricao":"Prazo expirado para resposta"
            },
            "data":"10/02/2014 15:40:32",
            "codigo":6,
            "autor":"Sistema",
            "textos":[  
               {  
                  "texto":"(Sem Detalhes)",
                  "tipo":{  
                    "codigo":9,
                    "descricao":"Texto do Sistema"
                  }
               }
            ]
         },
         {  
            "tipo":{  
               "codigo":6,
               "descricao":"Prazo expirado para avaliação"
            },
            "data":"10/02/2014 15:43:39",
            "codigo":7,
            "autor":"Sistema",
            "textos":[  
               {  
                  "texto":"(Sem Detalhes)",
                  "tipo":{  
                    "codigo":9,
                    "descricao":"Texto do Sistema"
                  }
               }
            ]
         }
      ],
      "acoes":[  
            {  
               "rel":"complementar", "href":"{url-ambiente}/reclamacao/20140100000091189/complementar",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"responder", "href":"{url-ambiente}/reclamacao/20140100000091189/responder",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"analise_procon", "href":"{url-ambiente}/reclamacao/20140100000091189/recusar",
               "type":"application/json", "method":"POST"
            },
            {  
               "rel":"redirecionar", "href":"{url-ambiente}/reclamacao/20140100000091189/redirecionar",
               "type":"application/json", "method":"POST"
            }
        ]
   },
   "codigoMensagem":1,
   "mensagem":"Ok."
}

Baixar Bytes de um Anexo

O que é

Serviço que retorna o conteúdo os dados de um anexo. Anexos estão relacionados a um trâmite, que por sua vez estão relacionados a uma reclamação. O valor retornado será um array de bytes convertido em texto base64.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/tramite/{codigoTramite}/anexo/{codigoAnexo}/baixar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
codigoTramite	Numérico	Sim	Código do trâmite relacionado ao anexo.
codigoAnexo	Numérico	Sim	Código do anexo.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dado	Objeto	Não	Valores do dado retornado (somente um objeto). Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro do Objeto de Dado

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código do anexo.
nome	Texto	Sim	Nome do arquivo com a extensão.
tamanho	Numérico	Sim	Tamanho do arquivo em bytes.
arquivoBase64	Texto	Sim	O conteúdo do arquivo. Texto base64 de um array de bytes.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dado":{  
      "codigo":1,
      "nome":"comprovante.jpg",
      "tamanho":879394,
      "arquivoBase64":"/9j/4AAQSkZJRgABAgEAYABgAAD/7gAOQWRAZAA[...]IAAcBMgACAA1gNBSv2+Vem1lJBCmifYPt4kV/ydf/2Q=="
   }
}

Imprimir Reclamação (Espelho)

O que é

Serviço que retorna o conteúdo os dados da reclamação condensadas em um arquivo PDF. O valor retornado será um array de bytes convertido em texto base64.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/baixar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dado	Objeto	Não	Valores do dado retornado (somente um objeto). Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro do Objeto de Dado

Campo	Formato	Obrigatório	Descrição
nome	Texto	Sim	Nome do arquivo com a extensão.
arquivoBase64	Texto	Sim	O conteúdo do arquivo. Texto base64 de um array de bytes.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dado":{
      "nome":"Reclamacao 123456789.pdf",
      "arquivoBase64":"/9j/4AAQSkZJRgABAgEAYABgAAD/7gAOQWRAZAA[...]IAAcBMgACAA1gNBSv2+Vem1lJBCmifYPt4kV/ydf/2Q=="
   }
}

Listagem de Trâmites por Período

O que é

Serviço que retorna a listagem dos trâmites das reclamações por um período de tempo. Alguns dos parâmetros de filtragem são opcionais, e por isso, devem ser passados como parâmetros da requisição, podendo ser omitidos caso não sejam utilizados.

URL: {url-ambiente}/tramites/periodo/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
dataInicioPeriodo	Texto	Sim	Data inicial da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaInicioPeriodo	Texto	Não	Hora referente a data inicial da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '00:00:00'.
dataFimPeriodo	Texto	Sim	Data final da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaFimPeriodo	Texto	Não	Hora referente a data final da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '23:59:59'.
codigoTipoTramite	Numérico	Não	Tipo de Trâmite para filtrar os resultados.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código do trâmite.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
autor	Texto	Sim	Autor do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.
textos	Lista	Sim	Listagem com os textos do trâmite.
anexos	Lista	Não	Listagem com os possíveis anexos do trâmite, sem os bytes do arquivo, mas cada anexo há opção para baixar os bytes em Base64.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {  
         "codigo":1,
         "tipo":{  
            "codigo":1,
            "descricao":"Abertura da Reclamação"
         },
         "data":"05/08/2014 16:49:26",
         "autor":"(autor)",
         "protocoloReclamacao":20140100000001261,
         "textos":[  
            {  
               "texto":"N",
               "tipo":{  
                    "codigo":1,
                    "descricao":"Indicador de Contato com o Fornecedor"
               }
            },
            {  
               "texto":"Reclamar em nome de terceiros.",
               "tipo":{  
                    "codigo":3,
                    "descricao":"Descrição da Reclamação"
               }
            },
            {  
               "texto":"Utilizar ou enviar informações ilegais, agressivas, caluniosas, abusivas, difamatórias, obscenas, invasivas a privacidade de terceiros, ou que atentem contra os bons costumes, a moral ou ainda que contrariem a ordem pública.",
               "tipo":{  
                    "codigo":4,
                    "descricao":"Pedido da Reclamação"
               }
            }
         ]
      },
      {  
         "codigo":2,
         "tipo":{  
            "codigo":2,
            "descricao":"Recebido pelo Fornecedor"
         },
         "data":"05/08/2014 16:49:46",
         "autor":"(empresa)",
         "protocoloReclamacao":20140100000001261,
         "textos":[  
            {  
               "texto":"(Sem Detalhes)",
               "tipo":{  
                    "codigo":9,
                    "descricao":"Texto do Sistema"
               }
            }
         ]
      }
   ]
}

Listagem de Trâmites por Período de forma paginada

O que é

Serviço que retorna a listagem dos trâmites das reclamações por um período de tempo de forma paginada. Alguns dos parâmetros de filtragem são opcionais, e por isso, devem ser passados como parâmetros da requisição, podendo ser omitidos caso não sejam utilizados.

URL: {url-ambiente}/tramites/periodo/listar/paginado

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
page	Numérico	Sim	Página da lista que deseja retornar. Página inicial sempre será a 0.
size	Numérico	Não	Define o número de registros que serão exibidos por página da consulta. Este parâmetro é opcional e, se não for informado, o valor padrão será 50. O usuário pode informar um valor para "size" entre 1 e 100. Se o usuário informar um valor maior que 100, a API irá definir o valor de "size" como 100 automaticamente.
dataInicioPeriodo	Texto	Sim	Data inicial da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaInicioPeriodo	Texto	Não	Hora referente a data inicial da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '00:00:00'.
dataFimPeriodo	Texto	Sim	Data final da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaFimPeriodo	Texto	Não	Hora referente a data final da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '23:59:59'.
codigoTipoTramite	Numérico	Não	Tipo de Trâmite para filtrar os resultados.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dado	Objeto	Não	Valores do dado retornado (somente um objeto). Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro do Objeto de Dado

Campo	Formato	Obrigatório	Descrição
content	Lista	Sim	Lista com o conteúdo da página requisitada.
size	Numérico	Sim	Número de resultados por página que foi informando na requisição. Valor padrão 50.
number	Numérico	Sim	Número da página atual.
sort	Numérico	Não	Não utilizado, valor sempre nulo.
totalElements	Numérico	Sim	Número total de elementos.
numberOfElements	Numérico	Sim	Número total de elementos na página atual.
firstPage	Booleano	Sim	Indica se é primeira página da lista de resultados.
lastPage	Booleano	Sim	Indica se é última página da lista de resultados.
totalPages	Numérico	Sim	Número total de páginas da requisição.

Campos dentro da Lista de Conteúdo

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código do trâmite.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
autor	Texto	Sim	Autor do trâmite.
textos	Lista	Sim	Listagem com os textos do trâmite.
anexos	Lista	Não	Listagem com os possíveis anexos do trâmite, sem os bytes do arquivo, mas cada anexo há opção para baixar os bytes em Base64.

Exemplo de Resposta

{
   "dado":{
      "content":[
         {
            "codigo":1,
            "tipo":{
               "codigo":1,
               "descricao":"Abertura da Reclamação"
            },
            "data":"05/08/2014 16:49:26",
            "autor":"(autor)",
            "protocoloReclamacao":20140100000001261,
            "textos":[
               {
                  "texto":"N",
                  "tipo":{
                     "codigo":1,
                     "descricao":"Indicador de Contato com o Fornecedor"
                  }
               },
               {
                  "texto":"Reclamar em nome de terceiros.",
                  "tipo":{
                     "codigo":3,
                     "descricao":"Descrição da Reclamação"
                  }
               },
               {
                  "texto":"Utilizar ou enviar informações ilegais, agressivas, caluniosas, abusivas, difamatórias, obscenas, invasivas a privacidade de terceiros, ou que atentem contra os bons costumes, a moral ou ainda que contrariem a ordem pública.",
                  "tipo":{
                     "codigo":4,
                     "descricao":"Pedido da Reclamação"
                  }
               }
            ]
         },
         {
            "codigo":2,
            "tipo":{
               "codigo":2,
               "descricao":"Recebido pelo Fornecedor"
            },
            "data":"05/08/2014 16:49:46",
            "autor":"(empresa)",
            "protocoloReclamacao":20140100000001261,
            "textos":[
               {
                  "texto":"(Sem Detalhes)",
                  "tipo":{
                     "codigo":9,
                     "descricao":"Texto do Sistema"
                  }
               }
            ]
         }
      ],
      "sort":null,
      "totalElements":2,
      "totalPages":1,
      "numberOfElements":2,
      "firstPage":true,
      "lastPage":true,
      "size":50,
      "number":0
   },
   "codigoMensagem":1,
   "mensagem":"Ok."
}

Listagem de Trâmites por Protocolo

O que é

Serviço que retorna a listagem dos trâmites de uma reclamação específica. Alguns dos parâmetros de filtragem são opcionais, e por isso, devem ser passados como parâmetros da requisição, podendo ser omitidos caso não sejam utilizados.

URL: {url-ambiente}/tramites/reclamacao/{numeroProtocolo}/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
dataInicioPeriodo	Texto	Não	Data inicial da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaInicioPeriodo	Texto	Não	Hora referente a data inicial da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '00:00:00'.
dataFimPeriodo	Texto	Não	Data final da criação do trâmite, no formato 'dd-MM-yyyy'. É obrigatório.
horaFimPeriodo	Texto	Não	Hora referente a data final da criação do trâmite, no formato 'HH:mm:ss'. Caso não preenchida assumirá '23:59:59'.
codigoTipoTramite	Numérico	Não	Tipo de Trâmite para filtrar os resultados.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código do trâmite.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
autor	Texto	Sim	Autor do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.
textos	Lista	Sim	Listagem com os textos do trâmite.
anexos	Lista	Não	Listagem com os possíveis anexos do trâmite, sem os bytes do arquivo, mas cada anexo há opção para baixar os bytes em Base64.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {  
         "codigo":1,
         "tipo":{  
            "codigo":1,
            "descricao":"Abertura da Reclamação"
         },
         "data":"05/08/2014 16:49:26",
         "autor":"(autor)",
         "protocoloReclamacao":20140100000001261,
         "textos":[  
            {  
               "texto":"N",
               "tipo":{  
                    "codigo":1,
                    "descricao":"Indicador de Contato com o Fornecedor"
               }
            },
            {  
               "texto":"Reclamar em nome de terceiros.",
               "tipo":{  
                    "codigo":3,
                    "descricao":"Descrição da Reclamação"
               }
            },
            {  
               "texto":"Utilizar ou enviar informações ilegais, agressivas, caluniosas, abusivas, difamatórias, obscenas, invasivas a privacidade de terceiros, ou que atentem contra os bons costumes, a moral ou ainda que contrariem a ordem pública.",
               "tipo":{  
                    "codigo":4,
                    "descricao":"Pedido da Reclamação"
               }
            }
         ]
      },
      {  
         "codigo":2,
         "tipo":{  
            "codigo":2,
            "descricao":"Recebido pelo Fornecedor"
         },
         "data":"05/08/2014 16:49:46",
         "autor":"(empresa)",
         "protocoloReclamacao":20140100000001261,
         "textos":[  
            {  
               "texto":"(Sem Detalhes)",
               "tipo":{  
                    "codigo":9,
                    "descricao":"Texto do Sistema"
               }
            }
         ]
      }
   ]
}

Alterações em Reclamações:

Complementar Reclamação

O que é

Serviço para complementar uma reclamação, com ou sem anexo. O usuário deve ter permissão para efetuar esta ação.

Os dados devem ser um texto Json compatíveis com os parâmetros.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/complementar

Método HTTP: POST.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
texto	Numérico	Sim	Lista de objetos anexos. Opcional, mas caso passe, o usuário deve ser permissão para anexar. É o segundo atributo do JSon de envio.
anexos	Lista	Não	Texto do complemento. É o primeiro atributo do JSon de envio.

Parâmetros do Anexo

Campo	Formato	Obrigatório	Descrição
nome	Texto	Sim	Nome do arquivo com a extensão.
tamanho	Numérico	Sim	Tamanho do arquivo em bytes.
arquivoBase64	Texto	Sim	O conteúdo do arquivo. Texto base64 de um array de bytes.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
codigo	Numérico	Sim	Código do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "codigo":1,
   "tipo":{
      "codigo":6,
      "descricao":"Complemento da Reclamação"
   },
   "data":"05/08/2014 16:49:26",
   "protocoloReclamacao":20140100000001261
}

Responder Reclamação

O que é

Serviço para responder uma reclamação ao consumidor, com ou sem anexo. O usuário deve ter permissão para efetuar esta ação.

Os dados devem ser um texto Json compatíveis com os parâmetros.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/responder

Método HTTP: POST.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
texto	Numérico	Sim	Lista de objetos anexos. Opcional, mas caso passe, o usuário deve ser permissão para anexar. É o segundo atributo do JSon de envio.
anexos	Lista	Não	Texto do complemento. É o primeiro atributo do JSon de envio.

Parâmetros do Anexo

Campo	Formato	Obrigatório	Descrição
nome	Texto	Sim	Nome do arquivo com a extensão.
tamanho	Numérico	Sim	Tamanho do arquivo em bytes.
arquivoBase64	Texto	Sim	O conteúdo do arquivo. Texto base64 de um array de bytes.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
codigo	Numérico	Sim	Código do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "codigo":1,
   "tipo":{
      "codigo":3,
      "descricao":"Resposta"
   },
   "data":"05/08/2014 16:49:26",
   "protocoloReclamacao":20140100000001261
}

Encaminhar para Análise do Gestor

O que é

Serviço para encaminhar uma reclamação para análise do gestor, com ou sem anexo. O usuário deve ter permissão para efetuar esta ação.

Os dados devem ser um texto Json compatíveis com os parâmetros.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/recusar

Método HTTP: POST.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
texto	Numérico	Sim	Lista de objetos anexos. Opcional, mas caso passe, o usuário deve ser permissão para anexar. É o segundo atributo do JSon de envio.
anexos	Lista	Não	Texto do complemento. É o primeiro atributo do JSon de envio.

Parâmetros do Anexo

Campo	Formato	Obrigatório	Descrição
nome	Texto	Sim	Nome do arquivo com a extensão.
tamanho	Numérico	Sim	Tamanho do arquivo em bytes.
arquivoBase64	Texto	Sim	O conteúdo do arquivo. Texto base64 de um array de bytes.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
codigo	Numérico	Sim	Código do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "codigo":1,
   "tipo":{
      "codigo":8,
      "descricao":"Recusado"
   },
   "data":"05/08/2014 16:49:26",
   "protocoloReclamacao":20140100000001261
}

Redirecionar para Outra Empresa do Mesmo Grupo

O que é

Serviço para redirecionar uma reclamação para outra empresa de mesmo grupo econômico. O usuário deve ter permissáo para efetuar esta ação.

Os dados devem ser um texto Json compatíveis com os parâmetros.

URL: {url-ambiente}/reclamacao/{numeroProtocolo}/redirecionar

Método HTTP: POST.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
numeroProtocolo	Numérico	Sim	Número do protocolo, que identifica uma única reclamação.
identificacaoEmpresaGrupo	Numérico	Sim	Código da empresa para redirecionamento.
texto	Numérico	Sim	Lista de objetos anexos. Opcional, mas caso passe, o usuário deve ser permissão para anexar. É o segundo atributo do JSon de envio.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
tipo	Objeto	Sim	Código e Descrição do tipo do trâmite. Como a descrição poderá sofrer mudanças no texto, é aconselhado a relação da chave 'código' com as listagens do Cadastros Básicos para consistência.
data	Texto	Sim	Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
codigo	Numérico	Sim	Código do trâmite.
protocoloReclamacao	Numérico	Sim	Número do protocolo da reclamação referente ao trâmite.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "codigo":1,
   "tipo":{
      "codigo":10,
      "descricao":"Alteracao Fornecedor"
   },
   "data":"05/08/2014 16:49:26",
   "protocoloReclamacao":20140100000001261
}

Cadastros Básicos:

Listagem de Situações

O que é

Serviço que retorna a listagem de situações com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/situacoes/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "codigo":1,
         "descricao":"Aberta"
      },
      {  
         "codigo":2,
         "descricao":"Em análise pelo fornecedor"
      },
      {  
         "codigo":3,
         "descricao":"Encerrada"
      },
      {  
         "codigo":4,
         "descricao":"Finalizada avaliada"
      },
      {  
         "codigo":5,
         "descricao":"Finalizada não avaliada"
      }
   ]
}

Listagem de Meios de Consumo

O que é

Serviço que retorna a listagem de meios de consumo com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/meiosconsumo/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "codigo":1,
         "descricao":"Internet"
      },
      {  
         "codigo":2,
         "descricao":"Loja física"
      },
      {  
         "codigo":3,
         "descricao":"Telefone"
      },
      {  
         "codigo":4,
         "descricao":"Catálogo"
      },
      {  
         "codigo":5,
         "descricao":"Domicílio"
      }
   ]
}

Listagem de Tipos de Trâmites

O que é

Serviço que retorna a listagem de tipos de trâmites com código e descrição. Deve ser utilizado para o filtro da listagem de reclamaçães ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/tipostramite/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "codigo":1,
         "descricao":"Abertura da reclamação"
      },
      {  
         "codigo":2,
         "descricao":"Visualizada pelo fornecedor"
      },
      {  
         "codigo":3,
         "descricao":"Resposta do fornecedor"
      },
      {  
         "codigo":4,
         "descricao":"Avaliação do consumidor"
      },
      {  
         "codigo":5,
         "descricao":"Reclamação finalizada"
      },
      {  
         "codigo":6,
         "descricao":"Complemento da reclamação"
      }
   ]
}

Listagem de Procons

O que é

Serviço que retorna a listagem de procons com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/procons/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "codigo":20140106000000201,
         "descricao":"Procon Acre"
      },
      {  
         "codigo":20140106000000202,
         "descricao":"Procon DF"
      },
      {  
         "codigo":20140106000000203,
         "descricao":"SENACON"
      }
   ]
}

Listagem de Tipos de Texto dos Trâmites

O que é

Serviço que retorna a listagem de tipos de texto dos trâmites, com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/tipostextotramite/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{  
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[  
      {  
         "codigo":1,
         "descricao":"Indicador de contato com o fornecedor"
      },
      {  
         "codigo":7,
         "descricao":"Índice de satisfação do consumidor"
      },
      {  
         "codigo":1005,
         "descricao":"Código/Matrícula da unidade consumidora"
      },
      {  
         "codigo":1008,
         "descricao":"Valor da Parcela"
      }
   ]
}

Listagem de Fornecedores do Meu Grupo

O que é

Serviço que retorna a listagem dos fornecedores do meu grupo econômico, com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código. A restrição ao grupo é feito internamente pela credenciada de acesso.

URL: {url-ambiente}/cadastros/subsidiarias/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

    {
       "codigoMensagem":1,
       "mensagem":"Ok.",
       "dados":[
          {
             "codigo":20140106000000001,
             "descricao":"BANKPAR "
          },
          {
             "codigo":20140106000000002,
             "descricao":"BRADESCARD"
          },
          {
             "codigo":20140106000000003,
             "descricao":"BRADESCO"
          },
          {
             "codigo":20140106000000004,
             "descricao":"BRADESCO FINANCIAMENTOS"
          },
          {
             "codigo":20140106000000005,
             "descricao":"BRADESCO SEGUROS"
          }
       ]
    }

Listagem de Municípios por Estado

O que é

Serviço que retorna a listagem de municípos por estado, com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/uf/{siglaUF}/municipios/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
siglaUF	Texto	Sim	Sigla do estado dos municípios a serem pesquisados. Ex: PA, SP, MS, DF.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {
         "codigo":0000001,
         "descricao":"Acrelândia"
      },
      {
         "codigo":0000002,
         "descricao":"Brasilíia"
      },
      {
         "codigo":0000003,
         "descricao":"Capixaba"
      },
      {
         "codigo":0000004,
         "descricao":"Epitaciolândia"
      },
      {
         "codigo":0000005,
         "descricao":"Feijó"
      },
      {
         "codigo":0000006,
         "descricao":"Porto Walter"
      },
      {
         "codigo":0000007,
         "descricao":"Rio Branco"
      },
      {
         "codigo":0000008,
         "descricao":"Xapuri"
      }
   ]
}

Listagem de Áreas

O que é

Serviço que retorna a listagem de áreas com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/areas/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {
         "codigo":1,
         "descricao":"Produtos de telefonia e informática"
      },
      {
         "codigo":2,
         "descricao":"Telecomunicações"
      },
      {
         "codigo":3,
         "descricao":"Transportes"
      }
   ]
}

Listagem de Assuntos por Área

O que é

Serviço que retorna a listagem de assuntos de uma área, com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/area/{codigoArea}/assuntos/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
codigoArea	Numérico	Sim	Código da área das reclamações.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {
         "codigo":1,
         "descricao":"Aparelho de telefone fixo / interfone"
      },
      {
         "codigo":2,
         "descricao":"Demais aparelhos de comunicação"
      },
      {
         "codigo":3,
         "descricao":"Microcomputador e laptops"
      }
   ]
}

Listagem de Problemas por Assunto

O que é

Serviço que retorna a listagem de problemas de um assunto, com código e descrição. Deve ser utilizado para o filtro da listagem de reclamações ou dados que retornem somente o código.

URL: {url-ambiente}/cadastros/assunto/{codigoAssunto}/problemas/listar

Método HTTP: GET.

Parâmetros de Envio

Campo	Formato	Obrigatório	Descrição
Content-Type	Texto	Sim	valor fixo: application/json;charset=UTF-8
Host	Texto	Sim	valor endereço root de acesso sem 'https'. Depende da {url-ambiente}. É provável que seu client coloque por padrão, caso tenha erro 'HANDSHAKE_FAILURE', tente retirar esse item.
Accept	Texto	Sim	valor fixo: application/json
User-Agent	Texto	Sim	valor fixo: api-consumidor
Authorization	Texto	Sim	Token de acesso. Exemplo de valor: Bearer b895ec3c0e14d76967b564e2fa795862. Mais informações veja o Serviço de Segurança.
versao	Texto	Sim	Número da versão do sistema Webservice. Exemplo de valor: 1.0. A versões disponíveis estarão contidas nesta página.
cpfAutorizado	Numérico	Sim	CPF do usuário autorizado. Deve ser um usuário válido ativo da credenciada.
codigoAssunto	Numérico	Sim	Código do assunto relacionado com a área.

Campos da Resposta

Campo	Formato	Obrigatório	Descrição
codigoMensagem	Numérico	Sim	Código de retorno. Mais detalhes na Aba de Mensagens.
mensagem	Texto	Sim	Mensagem de retorno. Mais detalhes na Aba de Mensagens.
dados	Lista	Não	Lista de com os dados retornados. Caso não exista retorno ou ocorra erro, será omitido.

Campos dentro da Lista de Dados

Campo	Formato	Obrigatório	Descrição
codigo	Numérico	Sim	Código único do dado.
descricao	Texto	Sim	Descrição ou nome do dado.

Exemplo de Resposta

{
   "codigoMensagem":1,
   "mensagem":"Ok.",
   "dados":[
      {
         "codigo":1,
         "descricao":"Dificuldade de contato / demora no atendimento"
      },
      {
         "codigo":2,
         "descricao":"Má qualidade no atendimento (descortesia / despreparo/ constrangimento)"
      },
      {
         "codigo":3,
         "descricao":"Cobrança de valor para a devolução do produto"
      },
      {
         "codigo":4,
         "descricao":"Cobrança em duplicidade / Cobrança referente a pagamento já efetuado"
      },
      {
         "codigo":5,
         "descricao":"Recusa em cancelar compra/serviço no prazo de arrependimento (compra fora do estabelecimento)"
      },
      {
         "codigo":6,
         "descricao":"Não envio / atraso do boleto ou fatura / dificuldade com o pagamento"
      }
   ]
}

procon, reclamação, conciliação, empresa, consumidor, consumidor.gov.br, consumidor.gov, governo, sindec, senacon, mj, miniterio da justiça, secretaria nacional do consumidor, plano de defesa do consumidor, plandec, portal do consumidor, conflitos, consumo, conflitos de consumo

Integração e API

Acesso REST - Credenciada Fornecedor

Versão Atual: 1.0 (BETA)

Disponibilidade: das 3:00hs até 7:59hs e de 12:00hs até 13:59hs, acesso livre. Fora dessa faixa, acesso limitado.

Parâmetros de Envio

Campos da Resposta

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro do Objeto de Dado

Campos dentro da Lista de Conteúdo

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro do Objeto de Dado

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro do Objeto de Dado

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro do Objeto de Dado

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro do Objeto de Dado

Campos dentro da Lista de Conteúdo

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Parâmetros do Anexo

Campos da Resposta

Exemplo de Resposta

Parâmetros de Envio

Parâmetros do Anexo

Campos da Resposta

Exemplo de Resposta

Parâmetros de Envio

Parâmetros do Anexo

Campos da Resposta

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados

Exemplo de Resposta

Parâmetros de Envio

Campos da Resposta

Campos dentro da Lista de Dados