Entrar com gov.br

Realize seu cadastro/login por meio da Conta gov.br, login único para acesso a serviços públicos digitais.

É necessário possuir uma conta nível PRATA ou OURO para registrar e acompanhar suas reclamações no Consumidor.gov.br.

Não forneça sua senha para outra pessoa. Ela é individual e intransferível.

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

Início do conteúdo

Integração e API

API

Para integrar o seu sistema ao Consumidor.gov.br foi criado uma API 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:

  1. 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.
  2. 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.
  3. 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.

A API nada mais é do que uma abstração em Java, dos acessos aos recursos do Webservice REST. Caso não possa utilizar a API, pode-se acessar pelas URL's diretamente.

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. Porém utilizando esta API, estes passos são totalmente transparentes.

Caso ocorra alguma validação de regra, obrigatoriedade ou consistência, será lançado ValidacaoRespostaRemotaException contendo o código e a mensagem, que pode ser visto na Aba de Mensagens. Demais erros serão lançados como exceção runtime, e seu texto pode ser visto diretamente no corpo da exceção.

Este manual é indicado para desenvolvedores. Abaixo segue detalhes do uso da API.

  • Caso queira um exemplo de acesso em Java com a API, baixe este projeto.


Versão Atual: 1.0.7 (BETA)

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

JDK Compilação: 1.6

Referências: JavaDoc

Não temos Maven publico, então baixe aqui o JAR e configure um repo local em seu pom. Exemplo abaixo, o jar foi colocado em um diretorio "repo" dentro de "src/main/resources" do projeto que for utilizar a api. Para demais sistema de build, verificar configuração própria e utilizar o jar.
                            <repositories>

                                <repository>

                                    <id>local-maven-repo</id>

                                    <url>file:///src/main/resources/repo</url>

                                </repository>

                            </repositories>

                            

                            <dependencies>

                                <dependency>

                                    <groupId>br.gov.consumidor</groupId>

                                    <artifactId>consumidor-api</artifactId>

                                    <version>1.0.7</version>

                                </dependency>

                            </dependencies>

Classes de Acesso:

Na API existem 5 classes iniciais de acesso. Elas configuram dados ou indicam quais conjuntos de serviços você está tentando acessar.


A classe principal é a ConsumidorAPI, que contém um método estático de retorno da instância (Singleton). A partir dele, você deve escolher qual ação quer prosseguir:

  • Acesso sobre Segurança: contém métodos para adicionar as suas credenciais e gerar um token temporário a partir dessas credenciais. Esse token é obrigatório para acessar os demais serviços.
  • Acesso aos serviços de Cadastros Básicos: acessa aos recursos de listagens de dados básicos, como situações, municípios, áreas, assuntos, etc.
  • Acesso aos serviços de Consultas de Reclamações: acessa os recursos para listagem de reclamações, detalhes ou baixar anexos.
  • Acesso aos serviços de Alterações em Reclamação: acessa os recursos para complementos, resposta, etc.


SegurançaAPI:

  • 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, ocorrerm validação de segurança.

    Utiliza o padrão OAuth2, mas isso é transparente no uso da API. Internamente os dados estarão guardados na instância Singleton principal. Dessa forma, pode-se adicionar as credenciais somente uma única vez, mesmo para acessos a vários recursos distintos.

    Assim o retorno do Token está condicionado aos dados de segurança, e antes da chamada ao método de geração de Token, deve ser informada as credenciais de acesso cadastradas anteriomente na tela da sua credenciada.


    Método da Classe Principal: ConsumidorAPI.instance().seguranca()

    Método HTTP no acesso interno: POST.


    Método de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    gerarToken (nenhum)
    • AutorizacaoInvalidaException
    • ProblemaAcessoException
    		 ConsumidorAPI Gera um novo token a partir dos dados credenciais. Retorna a classe principal da API para poder tomar outro fluxo, caso queira acessar os serviços logo em seguida.

    Dados Credenciais

    Nome do Método Tipo Obrigatório Descrição
    setIdCredenciada Long Sim ID da Credenciada. Pode ser visto na tela de edição da sua credenciada.
    setCodigoAutenticacao String Sim Código de Autenticação. Pode ser visto na tela de edição da sua credenciada.
    setSenha String Sim Senha de Autenticação. Pode ser visto na tela de edição da sua credenciada.

    Exemplo de Código

    ConsumidorAPI.instance().seguranca()
                            .setIdCredenciada(CLIENTE_ID)
                            .setCodigoAutenticacao(CODIGO)
                            .setSenha(SENHA)
                                .gerarToken();

//acessa um recurso qualquer...
//acessa outro recurso... 
//...

ConsultarReclamacoesAPI:

  • 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, existem dois métodos para esta ação, um com objeto de filtro e outro sem.

    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.

    A partir de um objeto Reclamação, podemos seguir outros fluxos através dos métodos existentes nessa classe de retorno.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listar FiltroReclamacoes
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<Reclamacao> Retorna a listagem das reclamações conforme os filtros do parâmetro, restrito às reclamações da sua credenciada.
    listar (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<Reclamacao> Retorna a listagem das reclamações sem filtragem, restrito às reclamações da sua credenciada.

    Atributos do Parâmetro FiltroReclamacoes

    Atributo Tipo Obrigatório Descrição
    numeroProtocolo Long Não Número do protocolo, que identifica uma única reclamação.
    codigoTipoTramiteReclamacao Integer Não Código de um tipo de trâmite das reclamações.
    codigoSituacaoReclamacao Integer Não Código de uma situação das reclamações.
    avaliacao Integer Não Valor da avaliação do consumidor.
    nomeReclamante String 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 Long Não CPF do reclamante das reclamações. Somente os números.
    regiao Regiao Não Sigla da região dos endereços das reclamações.
    UF UF Não Sigla do estado dos endereços das reclamações. Ex: PA, SP, MS, DF.
    codigoMunicipio Long Não Código do município dos endereços das reclamações.
    situacaoVinculo Integer Não Código da situação do vínculo das reclamações.
    codigoGrupoEconomico Long Não Código do grupo ecônomico do fornecedor das reclamações.
    codigoMeioConsumo Integer Não Código do meio de consumo (campo 'Como Comprou/Contratou').
    codigoArea Integer Não Código da área das reclamações.
    codigoAssunto Integer Não Código do assunto relacionado com a área.
    codigoProblema Integer Não Código do problema relacionado com o assunto.
    notaConsumidor Integer Não Valor da nota que o consumidor deu para as reclamações. Válidos: 1 a 5.
    textoReferenciaFornecedor String Não Texto livre de referência nas reclamações.
    dataIniPrazo String 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 String 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 String Não Data inicial da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data final for preenchida.
    horaInicialPeriodo String 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 String Não Data final da abertura das reclamações, no formato 'dd-MM-yyyy'. É obrigatório caso a data inicial for preenchida.
    horaFinalPeriodo String 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'.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

//Versao 1: com filtragem dos dados		
FiltroReclamacoes filtroConsulta = new FiltroReclamacoes();
filtroConsulta.setNomeReclamante("João Paulo");

Set<Reclamacao> reclamacoes = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).listar(filtroConsulta);

//Versao 2: sem filtragem dos dados
Set<Reclamacao> reclamacoes = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).listar();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    protocolo Long Sim Número do protocolo, que identifica uma única reclamação.
    situacao CadastrosBasicos 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 Date Sim Objeto java.util.Date, sem hora.
    dataAbertura Date Sim Objeto java.util.Date, com hora.
    reclamante Usuario Sim Dados básicos do reclamente, com nome e CPF. Para mais dados, deve-se consultar os detalhes da reclamação.

    Métodos de Ação no Objeto de Resposta

    Nome do Método Exceções Retorno Descrição
    detalhar
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 DetalheReclamacao Retorna os detalhes da reclamação. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Detalhe da Reclamação'.
    complementar
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Envia um complemento para uma reclamação. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Complementar Reclamação'.
    responder
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Envia uma resposta para uma reclamação. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Responder Reclamação'.
    encaminharAnaliseGestor
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Encaminha uma reclamação para análise do gestor. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Encaminhar para Análise do Gestor'.
    redirecionarOutraEmpresa
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Redireciona uma reclamação para uma outra empresa de mesmo grupo econômico. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Redirecionar para Outra Empresa do Mesmo Grupo'.
  • Detalhe da Reclamação

    O que é

    Serviço que retorna os detalhes de uma única reclamação. Serão retornado dados dos trâmites e 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.

    A partir de um objeto Anexo dentro da lista de Trâmites, podemos seguir outros fluxos através dos métodos existentes nessa classe de retorno.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    detalhar Long protocolo
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 DetalheReclamacao Detalha uma reclamação.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;

DetalheReclamacao detalhe = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).detalhar(protocoloReclamacao);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    protocolo Long Sim Número do protocolo, que identifica uma única reclamação.
    situacao CadastrosBasicos 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 CadastrosBasicos 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 Date Sim Formato 'dd/MM/yyyy HH:mm:ss'.
    dataAbertura Date Sim Formato 'dd/MM/yyyy HH:mm:ss'.
    area CadastrosBasicos 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 CadastrosBasicos 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 CadastrosBasicos 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 Usuario Sim Detalhes do reclamante, com documento, endereço, emails e telefones, mas sem número de identificação.
    Os tipos de telefones podem ser:
    1. Residencial.
    2. Celular.
    3. Comercial.
    4. Público.
    . Os tipos de emails podem ser:
    1. Pessoal.
    2. Institucional.
    3. Fale Conosco.
    4. Notificação.
    5. Público.
    reclamado Usuario Sim Detalhes do reclamado, com documento e endereço.
    mediador Usuario Sim Detalhes do mediador, com documento e endereço.
    tramites Set<Tramite> 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.

    Métodos de Ação no Objeto de Resposta

    Nome do Método Exceções Retorno Descrição
    baixarBytesBase64
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 ArquivoAnexo Dentro dos trâmites consta a lista dos anexos. Para cada anexo, pode-se baixar os bytes do arquivo, que por padrão vem vazio. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico sobre 'Baixar Bytes de um Anexo'.
    complementar
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Envia um complemento para uma reclamação. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Complementar Reclamação'.
    responder
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Envia uma resposta para uma reclamação. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Responder Reclamação'.
    encaminharAnaliseGestor
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Encaminha uma reclamação para análise do gestor. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Encaminhar para Análise do Gestor'.
    redirecionarOutraEmpresa
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 (nenhum) Redireciona uma reclamação para uma outra empresa de mesmo grupo econômico. Internamente faz um novo acesso HTTP. Para mais informações, ver o tópico 'Redirecionar para Outra Empresa do Mesmo Grupo'.
  • 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âmites, que por sua vez esta relacionado a uma reclamação. O valor retornado será um array de bytes convertido em texto base64.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    baixarAnexo Long protocolo
    Integer codigoTramite
    Integer codigoAnexo
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 ArquivoAnexo Baixa os bytes em base64 de um anexo.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;
Long codigoTramite = 3L;
Long codigoAnexo = 1L;

ArquivoAnexo arquivoAnexo = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).baixarAnexo(protocoloReclamacao, codigoTramite, codigoAnexo);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código do anexo.
    nome String Sim Nome do arquivo com a extensão.
    tamanho Long Sim Tamanho do arquivo em bytes.
    arquivoBase64 String Sim O conteúdo do arquivo. Texto base64 de um array de bytes.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listarTramitesPorPeriodo FiltroTramites
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<Tramite> Retorna a listagem dos trâmites conforme períodos, assim os campos de datas do parâmetro são obrigatórios. Campos somente datas no formato 'dd-MM-yyyy'. Serão assumidos as horas máximas e mínimas ('00:00:00' e '23:59:59').

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

FiltroTramites filtroPeriodo = new FiltroTramites();
filtroPeriodo.setDataInicioPeriodo("22-08-2014");
filtroPeriodo.setDataFimPeriodo("20-09-2014");

Set<Tramite> tramites = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).listarTramitesPorPeriodo(filtroPeriodo);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código do trâmite.
    tipo CadastrosBasicos 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 Date Sim Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
    autor String Sim Autor do trâmite.
    protocoloReclamacao Numérico Sim Número do protocolo da reclamação referente ao trâmite.
    textos Set<TextoTramite> Sim Listagem com os textos do trâmite.
    anexos Set<Anexo> 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.
  • Listagem de Trâmites por Protocolo

    O que é

    Serviço que retorna a listagem dos trâmites de uma reclamação específica.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listarTramitesPorProtocolo Long protocoloReclamacao
    FiltroTramites filtro
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<Tramite> Retorna a listagem dos trâmites de uma reclamação, assim o campo de protocolo na URL é obrigatório.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;

//filtros sao opcionais
FiltroTramites filtroPeriodo = new FiltroTramites();

Set<Tramite> tramites = ConsumidorAPI.instance().consultarReclamacoes(cpfAutorizado).listarTramitesPorProtocolo(protocoloReclamacao, filtroPeriodo);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código do trâmite.
    tipo CadastrosBasicos 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 Date Sim Data de criação do trâmite. Formato 'dd/MM/yyyy HH:mm:ss'.
    autor String Sim Autor do trâmite.
    protocoloReclamacao Numérico Sim Número do protocolo da reclamação referente ao trâmite.
    textos Set<TextoTramite> Sim Listagem com os textos do trâmite.
    anexos Set<Anexo> 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.

Alterações em Reclamações:

  • Complementar Reclamação

    O que é

    Serviço para complementar uma reclamação, com ou sem anexo.

    No método inicial de acesso opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().alterarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: POST.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    complementar
    • Long protocolo
    • AlteraFluxoReclamacao alteracao
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 (nenhum) Complementa uma reclamação conforme os dados de protocolo e objeto 'AlteraFluxoReclamacao'. Os anexos são opcionais. Erros ou validações lançam exceção, mas sucesso não retorna nada.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;

AlteraFluxoReclamacao alteraFluxoReclamacao = new AlteraFluxoReclamacao("Justificativa da API Cliente. :)");

ConsumidorAPI.instance().alterarReclamacoes(cpfAutorizado).complementar(protocoloReclamacao, alteraFluxoReclamacao);

  • Responder Reclamação

    O que é

    Serviço para responder uma reclamação ao consumidor, com ou sem anexo.

    No método inicial de acesso opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().alterarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: POST.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    responder
    • Long protocolo
    • AlteraFluxoReclamacao alteracao
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 (nenhum) Responde uma reclamação conforme os dados de protocolo e objeto 'AlteraFluxoReclamacao'. Os anexos são opcionais. Erros ou validações lançam exceção, mas sucesso não retorna nada.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;

AlteraFluxoReclamacao alteraFluxoReclamacao = new AlteraFluxoReclamacao("Justificativa da API Cliente. :)");

ConsumidorAPI.instance().alterarReclamacoes(cpfAutorizado).responder(protocoloReclamacao, alteraFluxoReclamacao);

  • Encaminhar para Análise do Gestor

    O que é

    Serviço para encaminhar uma reclamação para análise do gestor, com ou sem anexo.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().alterarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: POST.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    encaminharAnaliseGestor
    • Long protocolo
    • AlteraFluxoReclamacao alteracao
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 (nenhum) Encaminha uma reclamação ao gestor conforme os dados de protocolo e objeto 'AlteraFluxoReclamacao'. Os anexos são opcionais. Erros ou validações lançam exceção, mas sucesso não retorna nada.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;

AlteraFluxoReclamacao alteraFluxoReclamacao = new AlteraFluxoReclamacao("Justificativa da API Cliente. :)");

ConsumidorAPI.instance().alterarReclamacoes(cpfAutorizado).encaminharAnaliseGestor(protocoloReclamacao, alteraFluxoReclamacao);

  • Redirecionar para Outra Empresa do Mesmo Grupo

    O que é

    Serviço para redirecionar uma reclamação para outra empresa de mesmo grupo econômico.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().alterarReclamacoes(String cpfAutorizado)

    Método HTTP no acesso interno: POST.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    redirecionarOutraEmpresa
    • Long protocolo
    • AlteraFluxoReclamacao alteracao
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 (nenhum) Encaminha uma reclamação ao gestor conforme os dados de protocolo e objeto 'AlteraFluxoReclamacao'. Os anexos são opcionais. Erros ou validações lançam exceção, mas sucesso não retorna nada.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long protocoloReclamacao = 20140100000091189L;
Long identificacaoEmpresaGrupo = 123123123L;

AlteraFluxoReclamacao alteraFluxoReclamacao = new AlteraFluxoReclamacao("Justificativa da API Cliente. :)", identificacaoEmpresaGrupo);

ConsumidorAPI.instance().alterarReclamacoes(cpfAutorizado).redirecionarOutraEmpresa(protocoloReclamacao, alteraFluxoReclamacao);

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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemSituacoes (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todas as situações ativas possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> situacoes = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemSituacoes();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemMeiosDeConsumo (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os meios de consumos ativos possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> meiosConsumo = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemMeiosDeConsumo();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemTiposTramite (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os tipos de trâmites ativos possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> tiposTramite = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemTiposTramite();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemProcons (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os procons ativos possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> procons = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemProcons();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemTiposTextoTramite (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os tipos de texto dos trâmites possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> procons = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemTiposTextoTramite();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemSubsidiarias (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todas as empresas ativas possíveis para as reclamações, do seu grupo econômico.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> subsidiarias = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemSubsidiarias();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemMunicipiosPorSiglaUF UF uf
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os municípios possíveis para as reclamações. O parâmetro UF é um Enum interno da API.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> municipios = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemMunicipiosPorSiglaUF( UF.MS );

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemAreas (nenhum)
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todas as áreas ativas possíveis para as reclamações.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;

Set<CadastrosBasicos> areas = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemAreas();

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • Listagem de Assuntos por Área

    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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemAssuntosPorArea Integer codigoArea
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os assuntos ativos possíveis para as reclamações, de uma área.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long codigoArea = 10L;

Set<CadastrosBasicos> assuntos = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemAssuntosPorArea(codigoArea);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.
  • Listagem de Problemas por Assunto

    O que é

    Serviço que retorna a listagem de problemas de uma 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.

    No método inicial de acesso é opcional o parâmetro 'cpfAutorizado'. Caso não passe, as ações serão vinculadas a um usuário padrão da sua credenciada, mas caso conste, o seu usuário deverá ter as permissões necessárias.


    Métodos da Classe Principal:

    • ConsumidorAPI.instance().consultarCadastrosBasicos(String cpfAutorizado)

    Método HTTP no acesso interno: GET.

    Restrição: Antes de utilizar este serviço, deve estar inserido no contexto Singleton um Token de acesso. Para saber mais, veja o tópico sobre 'Autenticação e Geração do Token'.


    Métodos de Acesso

    Nome do Método Parâmetros Exceções Retorno Descrição
    listagemProblemasPorAssunto Integer codigoAssunto
    • ValidacaoRespostaRemotaException
    • TokenExpiradoException
    • ProblemaGenericoAPIException
    • ParametrosAPIException
    		 Set<CadastrosBasicos> Retorna a listagem de todos os problemas ativos possíveis para as reclamações, de um assunto.

    Exemplo de Código

    //Antes, gerar um token de segurança.
//-----------
Long cpfAutorizado = 00100200344L;
Long codigoAssunto = 40L;

Set<CadastrosBasicos> problemas = ConsumidorAPI.instance().consultarCadastrosBasicos(cpfAutorizado).listagemProblemasPorAssunto(codigoAssunto);

    Atributos do Objeto de Resposta

    Atributo Tipo Obrigatório Descrição
    codigo Integer Sim Código único do dado.
    descricao String Sim Descrição ou nome do dado.

ConfiguracaoAPI:

  • Alterar Dados de Acesso e Certificado

    O que é

    Internamente ao executar a API, localmente, configura-se alguns dados de acesso, sem necessidade de intervenções ou alterações para o usuário desta API.

    Mas pode existir algum impedimento ou problema que force a alteração desses dados básicos durante o seu uso. Essas configurações podem ser alteradas através desses métodos antes das chamadas aos serviços remotos.

    ATENÇÃO: alterações indevidas ou inválidas podem ocasionar problemas no acesso e uso da API. Utilize somente em casos de contingêcias ou restrições.


    Método da Classe Principal: ConsumidorAPI.instance().configuracao()

    Método HTTP no acesso interno: (nenhum).


    Métodos de Configurações

    Nome do Método Tipo Obrigatório Descrição
    setUrlBase String Não Insere a URL base de acesso aos serviços, sem barra ao final. Exemplo de valor: 'https://www.consumidor.gov.br'.
    setVersao String Não Insere a versão dos serviços a serem acessados. O formato é 'X.X'. Exemplo de valor: '1.0'.
    setPathCertificado String Não Insere o path local do arquivo de certificado A1 de acesso aos serviços. O caminho deve ser absoluto. OBS: Já existe internamente a referência a um arquivo 'keystore' padrão.

    Exemplo de Código

    ConsumidorAPI.instance().configuracao()
                            .setUrlBase("https://www.consumidor.gov.br")
                            .setVersao("1.0")
                            .setPathCertificado("/var/certificados/consumidor_ws.keystore");

//acessa um recurso qualquer...
//acessa outro recurso... 
//...

Início do rodapé
Serviços
Institucional
Política de Uso
Acesso a Informação
Selo Inovação