Integrar sua aplicação ao Passaporte Web é um processo bastante simples. Basta seguir os passos descritos aqui.
Para começar é necessário cadastrar sua aplicação no Passaporte Web. Você precisa:
As informações necessárias para a criação de uma aplicação são:
Campo Descrição Nome Nome da aplicação Slug Identificador da aplicação. Um slug não pode ser utilizado por mais de uma aplicação e pode ser formado por letras (a-z,A-Z), dígitos (0-9), sublinhado (_) e hifen (-) Grupo responsável Grupo que irá gerir esta aplicação. Os membros deste grupo na aplicação “Passaporte Web” terão acesso às ferramentas de administração desta aplicação e de suas informações relacionadas (usuários, etc)
Após submeter este formulário sua aplicação terá sido cadastrada, porém neste momento ela estará desabilitada e não possuirá acesso a nenhuma das funcionalidades do Passaporte Web.
O controle de acesso das aplicações ao Passaporte Web é feito com base nas credenciais das instâncias de uma aplicação.
Cada instância cadastrada possui um par de credenciais (denominadas token e secret) que deverão ser utilizadas em sua aplicação. Vale lembrar que estas credenciais (e todos os outros dados de suas aplicações) são acessíveis para qualquer membro do grupo responsável pela aplicação, portanto mantenha neste grupo somente as pessoas que necessitam do acesso a estas informações.
Para cadastrar a primeira instância de uma aplicação, siga os passos abaixo:
Acesse a Gerência de aplicações, na Administração do Passaporte Web
Cada uma das aplicações presentes na listagem possui uma série de links, dando acesso a diversas informações relacionadas a ela. Acessando o link “Nenhuma instância” você terá acesso à listagem de instâncias desta aplicação, e poderá criar uma nova instância. as informações necessárias são:
| Campo | Descrição |
|---|---|
| Label | Label desta instância. O label será exibido para os usuários em diversos pontos da interface do sistema, como a barra do passaporte. O label é o nome pelo qual seus usuários conhecem a aplicação |
| Descrição | Breve texto descrevendo esta instância, com o objetivo de identificar como ela é utilizada. Esta informação será visualizada somente pelos membros do grupo responsável pela aplicação. |
| URL SSO | Url na aplicação que inicia o processo de Single Sign On. Esta url será utilizada em diversas situações, como na barra do passaporte e após a ativação da conta de usuários cadastrados por sua aplicação. Caso o desenvolvimento da integração ainda esteja em andamento e você ainda não possua esta informação, utilize o valor padrão do formulário. Os dados das instâncias podem ser alterados posteriormente, portanto não é necessário se preocupar com isto no momento. |
Por padrão uma instância não é exibida na Barra de navegação do Passaporte Web pois provavelmente neste momento a implementação da integração ainda não terá sido finalizada.
Para exibir esta instância na barra de navegação de usuários de sua aplicação acesse o link “Editar”, verifique se o campo “Url SSO” contém a url correta e marque a opção “Exibir na barra de navegação”.
Após finalizar o cadastro de sua aplicação, você terá as informações necessárias para finalizar a implementação das funcionalidades relacionadas à integração com o Passaporte Web em sua aplicação.
Os itens relacionados à integração com o Passaporte Web que devem ser implementados são:
Autenticação e controle de acesso à aplicação, cujos mecanismos são descritos em:
Interface da aplicação adequada à identidade visual do Passaporte Web