Governo do Estado do Rio Grande do Sul

Início do conteúdo

Área do Desenvolvedor

O Painel do Desenvolvedor("Área do desenvolvedor") é a seção do Login Cidadão Gov.br para gestão de seu serviço. Para acessar utilize as URLs:
  1. E acesse o menu Área do desenvolvedor    

       2. Nela conterá a lista dos serviços do qual você faz parte da equipe de administração    

administrador

Dica: caso este menu não apareça para você, é preciso solicitar que seu perfil seja alterado para "Desenvolvedor" no Login Cidadão Gov.br, via atendimento-login@procergs.rs.gov.br.

Acesso a Client Id e Client Secret

Ao acessar um serviço você terá as informações de client_id e client_secret para a integração.
acesso client

Gerenciando seu serviço


É possível visualizar e alterar algumas informações relacionadas a seu serviço dentro do Login Cidadão Gov.br.
 Importante manter suas URLs com https!

Configuração do OAuth   

configuracao auth

  • URLs de callback (redirecionamento) - aqui precisam estar as URLs que a aplicação pode redirecionar. É possível adicionar ou remover alguma que não esteja mais em uso.
  • Post logout redirect uris - aqui precisam estar as URLs de redirecionamento para o logout do seu serviço

Liberando escopos

Para verificar os escopos, acessar a opção toggle options:

advanced auth

Nessa tela se encontram os escopos permitidos, você pode selecionar múltiplos:
advanced auth II
 

Lembrando: para selecionar mais de um escopo, pressione a tecla “Control (Ctrl)“. E pode ser habilitado um ou mais, depende apenas da necessidade do serviço.

Esta é apenas a liberação da permissão do uso do escopo.

Será necessário implementar a chamada do escopo novo em seu serviço.

Importante! Qualquer alteração de escopo fará uma solicitação de acesso ao usuário semelhante ao primeiro acesso feito pelo serviço.!

 

Liberando escopos especiais e utilizando escopos do GovBr

O administrador do serviço pode alterar a qualquer momento as permissões aos escopos especiais.

A lista dos “Restricted Scopes" é a lista dos escopos.

restricted Scopes

Níveis


Para utilizar o escopo NÍVEIS é necessário habilitar o escopo govbrniveis.

Especificações de como utilizar o Escopo

Após habilitado o escopo no serviço, o acesso ao mesmo fica disponibilizado para a aplicação, mas ainda depende da autorização expressa do usuário, como pode ser visto no primeiro acesso feito pelo serviço.

Este escopo é carregado automaticamente na base do Login Cidadão Gov.br no momento em que o usuário realiza o login.

E para buscar o conteúdo, precisa utilizar o campo govbrniveis, que é carregado junto com os dados do usuário no JSON de retorno (output), como nome, e-mail, CPF, etc…

Um exemplo de retorno:

try{​​
// A rotina processToClaims faz a decodificação e devolve o JSON
// será detalhada em documento específico
$json_output_payload_id_token = processToClaims($id_token, $json_output_jwk);
$govbrCNPJ = $json_output_payload_id_token[‘govbrniveis’];
}​​​​​​​​​​​​​​​​ catch (Exception $e) {​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
$detalhamentoErro = $e;
insereMensagemControle(1, $e->getMessage(), “FALHA AO PEGAR O PAYLOAD”);
die();
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ 

O campo vem sempre preenchido e tem como principal característica ser um recurso de segurança da informação da identidade, que permitem flexibilidade para realização do acesso, como pode ser visto em Níveis de Autenticação, Selos e Catálogo de Confiabilidades .

O campo é um JSON e seu torno é simples:

[{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"id":"1","dataAtualizacao":"2019-05-24T04:16:06.512-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​]

Ver mais detalhes em Resultado Esperado do Acesso ao Serviço de Confiabilidade Cadastral (Níveis) .

Categorias

Para utilizar o escopo CATEGORIAS é necessário habilitar o escopo govbrcategorias.

Especificações de como utilizar o Escopo

Após habilitado o escopo no serviço, o acesso ao mesmo fica disponibilizado para a aplicação, mas ainda depende da autorização expressa do usuário, como pode ser visto no primeiro acesso feito pelo serviço.

Este escopo é carregado automaticamente na base do Login Cidadão Gov.br no momento em que o usuário realiza o login.

E para utilizar o conteúdo, é só utilizar o campo govbrcategorias, que é carregado junto com os dados do usuário no JSON de retorno (output), como nome, e-mail, CPF, etc…

Um exemplo de retorno:

try{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
// A rotina processToClaims faz a decodificação e devolve o JSON
// será detalhada em documento específico
$json_output_payload_id_token = processToClaims($id_token, $json_output_jwk);
$govbrCNPJ = $json_output_payload_id_token['govbrcategorias'];
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ catch (Exception $e) {​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
$detalhamentoErro = $e;
insereMensagemControle(1, $e->getMessage(), "FALHA AO PEGAR O PAYLOAD");
die();
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ 

O campo vem sempre preenchido e tem como principal característica permitir a manutenção mais facilitada da utilização dos níveis e confiabilidades (selos) do Login Único, como pode ser visto em Níveis de Autenticação, Selos e Catálogo de Confiabilidades .

O campo é um JSON e seu torno contém códigos mais precisos:

[{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"id":"101","dataAtualizacao":"2019-05-24T04:16:06.512-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​,{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"id":"102","dataAtualizacao":"2019-05-24T04:16:06.512-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​]

Ver mais detalhes em Resultado Esperado do Acesso ao Serviço de Confiabilidade Cadastral (Categorias) .

Confiabilidade

Para utilizar o escopo CONFIABILIDADE é necessário habilitar o escopo govbrconfiabilidade.

Especificações de como utilizar o Escopo

Após habilitado o escopo no serviço, o acesso ao mesmo fica disponibilizado para a aplicação, mas ainda depende da autorização expressa do usuário, como pode ser visto no primeiro acesso feito pelo serviço.

Este escopo é carregado automaticamente na base do Login Cidadão Gov.br no momento em que o usuário realiza o login.

E para utilizar o conteúdo, é só utilizar o campo govbrconfiabilidade, que é carregado junto com os dados do usuário no JSON de retorno (output), como nome, e-mail, CPF, etc…

Um exemplo de retorno:

try{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
// A rotina processToClaims faz a decodificação e devolve o JSON
// será detalhada em documento específico
$json_output_payload_id_token = processToClaims($id_token, $json_output_jwk);
$govbrCNPJ = $json_output_payload_id_token['govbrconfiabilidade'];
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ catch (Exception $e) {​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
$detalhamentoErro = $e;
insereMensagemControle(1, $e->getMessage(), "FALHA AO PEGAR O PAYLOAD");
die();
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ 

O campo vem sempre preenchido e tem como principal característica permitir a qualificação das contas com a obtenção dos atributos autoritativos do cidadão a partir das bases oficias de governo, como pode ser visto em Níveis de Autenticação, Selos e Catálogo de Confiabilidades .

O campo é um JSON e seu torno contém códigos mais precisos:

[{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"id":"101","dataAtualizacao":"2019-05-24T04:16:06.512-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​,{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"id":"102","dataAtualizacao":"2019-05-24T04:16:06.512-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​]

Ver mais detalhes em Resultado Esperado do Acesso ao Serviço de Confiabilidade Cadastral (Categorias) .

Empresas

Para utilizar o escopo EMPRESAS é necessário habilitar o escopo govbrempresa.

Especificações de como utilizar o Escopo

Após habilitado o escopo no serviço, o acesso ao mesmo fica disponibilizado para a aplicação, mas ainda depende da autorização expressa do usuário, como pode ser visto no primeiro acesso feito pelo serviço.

Este escopo é carregado automaticamente na base do Login Cidadão gov.br no momento em que o usuário realiza o login.

E para buscar o conteúdo, precisa utilizar o campo govbrempresa, que é carregado junto com os dados do usuário no JSON de retorno (output), como nome, e-mail, CPF, etc…

Um exemplo de retorno:

try{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
// A rotina processToClaims faz a decodificação e devolve o JSON
// será detalhada em documento específico
$json_output_payload_id_token = processToClaims($id_token, $json_output_jwk);
$govbrCNPJ = $json_output_payload_id_token['govbrempresa'];
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ catch (Exception $e) {​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
$detalhamentoErro = $e;
insereMensagemControle(1, $e->getMessage(), "FALHA AO PEGAR O PAYLOAD");
die();
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ 

O campo estando preenchido, pode-se ter a certeza de que o usuário possui algum vinculo com alguma empresa, podendo ser uma ou mais. Caso não tenha vínculos com nenhuma empresa, o campo vem vazio: [].

O campo é um JSON e vem algo em torno de:

[{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​"cnpj":"9999999900010-","razaoSocial":"SOCIEDADE EMPRESARIAL","dataCriacao":"2010-09-09T11:29:22.855-0300"}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​]

CNPJ

Para utilizar o CNPJ é necessário habilitar o escopo govbrcnpj.

Especificações de como utilizar o Escopo

Após habilitado o escopo no serviço, o acesso ao mesmo fica disponibilizado para a aplicação, mas ainda depende da autorização expressa do usuário, como pode ser visto no primeiro acesso feito pelo serviço.

Este escopo é carregado automaticamente na base do Login Cidadão gov.br no momento em que o usuário realiza o login. Ele é devolvido em um forma JSON e pode ser visto em Escopos de Atributos , lá ele se refere ao item 2, "govbr_empresa".

E para buscar o conteúdo, precisa utilizar o campo govbrempresa, que é carregado junto com os dados do usuário no JSON de retorno (output), como nome, e-mail, CPF, etc…

Um exemplo de retorno:

try{​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
// A rotina processToClaims faz a decodificação e devolve o JSON
// será detalhada em documento específico
$json_output_payload_id_token = processToClaims($id_token, $json_output_jwk);
$govbrCNPJ = $json_output_payload_id_token['govbrcnpj'];
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ catch (Exception $e) {​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​
$detalhamentoErro = $e;
insereMensagemControle(1, $e->getMessage(), "FALHA AO PEGAR O PAYLOAD");
die();
}​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​​ 

Este campo é sempre preenchido caso o usuário tenha vínculo com alguma empresa. Caso não tenha, ele retorna vazio.

Conteúdos relacionados

RS.GOV.BR - Portal de Serviços Digitais