Introdução

O SDK para PHP permite que você adicione as funções de autenticação do tuidd ao seu site de maneira simples e rápida.

Esta página detalha os recursos do módulo e um guia rápido sobre como instalá-lo.

Instalação e configuração

Etapas de instalação

A instalação é feita através dos seguintes passos, para o detalhe de cada um
Você pode ver abaixo nas seções a seguir.

1. Crie uma conta da tuidd
   Como Provedor de Serviços ou Agente Atacadista, registre seu site ou aplicativo no Portal de gestão tuidd .

2. Baixe o SDK
   Você pode baixar a versão mais recente do SDK de aqui

3. Instalar
   Descompacte o arquivo ZIP que contém o SDK no diretório raiz de seu site. Ele irá criar um diretório chamado tuidd

4. Configurar o SDK
   Você precisará configurar o SDK seguindo as etapas detalhadas na seção Configuração do SDK
   

5. Integre o botão ao seu site
   Então, você deve colocar o botão de login seguindo as etapas de Integração do botão Login

Configuração do SDK

A configuração é feita seguindo estes passos :

1. Edite o arquivo tuidd.conf que está dentro do diretório tuidd / conf do SDK

2. Configure os parâmetros:

   client_id :
   É o ID do aplicativo gerado durante o registro do seu site no portal de administração do tuidd. Você pode encontrá-lo inserindo o site de gerenciamento no menu Meus Aplicativos .
   Exemplo: 73958620d779-4fdc-bc09-7d521af91278

   client_secret :
   É a chave que foi automaticamente atribuída ao aplicativo durante o registro no site de gerenciamento do tuidd. Você pode encontrá-lo inserindo o site de gerenciamento no menu Meus Aplicativos .
   Exemplo: 45759620e745-4adb-b329-5d521af3433

   home_page_url:
   É o URL onde você coloca o botão de login. Ele é usado para o SDK redirecionar quando o usuário não foi autenticado ou a sessão expirou.
   Exemplo: http://example.com

   home_login_url :
   É a URL para a qual o usuário será redirecionado no final do processo de autenticação.
   Exemplo: http://example.com/admin

   default_language :
   Idioma em que os textos são exibidos. Os valores possíveis são: Inglês (en), Espanhol (es), Português (pt) ou Francês (fr).
   Exemplo: es

Integração do botão Login

Passo 1:

Para que os usuários acessem os serviços do tuidd, você deve colocar o botão Login do tuidd em sua página. Isso nos permite identificar o usuário e garantir que ele deseja receber os serviços por meio de nossa plataforma.

Para isso, você deve incluir no código-fonte da página de login, a biblioteca do tuidd:

index.php

require_once('tuidd/tuidd_lib/tuidd.php'); // my code ... ?>

Nota : Caso você tenha instalado o SDK em outro site, você deve alterar o caminho ' tuidd / tuidd_lib / tuidd.php 'pelo correspondente.

Passo 2:

Por outro lado, você deve incluir em sua página, onde você deseja que o botão Login do tuidd, o DIV que o contém, seja desenhado:

index.php

O SDK cuidará automaticamente de pintar o botão quando você carregar sua página.

Se você modificou o id do div no arquivo de configuração, lembre-se de usá-lo também em sua página, em vez de tuidd-sdk na tag div.

Passo 3:

Você terá que copiar no início de todas as páginas do seu site que exigem acesso com um usuário logado, a seguinte linha de código:

include_once("tuidd/tuidd_lib/client/TuiddClient.php"); TuiddClient::getSingleton()->isLoggedIn(); ?>

Este código significa que, se o usuário não autenticou ou a sessão expirou, o sistema redireciona automaticamente para a página configurada no parâmetro home_page_url no arquivo de configuração.

Abaixo está um diagrama de como a implementação é:

Obtendo dados do usuário

Para obter os dados do usuário que iniciou a sessão, você pode fazer isso de duas maneiras:

1- Chamando a função getUserInfo ()

2- Implementando uma função de retorno de chamada (avançado)

Entre os dados do usuário que você receberá, o mais importante é o PCR. Identifica univocamente o usuário em seu site.

É retornado no parâmetro "subâ €" do objeto recebido.

Invocando a função getUserInfo ()

Esta função é usada para obter os dados do usuário.

Você pode usá-lo diretamente de sua página para acessar as informações do usuário, por exemplo, o nome e sobrenome, etc.

A informação é retornada dentro de um objeto user_info .

Exemplo:

include_once(' tuidd/tuidd_lib/client/TuiddClient.php '); // get user information $userInfo = TuiddClient::getSingleton()-> getUserInfo (); // print user information... echo ' Hello '; echo $userInfo['user_info']['name']." ".$userInfo['user_info']['family_name']; echo ' '; echo ' Your ID/:'; echo $userInfo['user_info']['sub']; echo ' '; echo ' Your email is: '; echo $userInfo['user_info']['email']; echo ' '; ?>

Para ver o restante dos campos disponíveis, consulte a seção Informação do usuário da API REST de autenticação .

Implementação da função de retorno de chamada

Essa função é invocada pelo SDK para processar as informações recebidas do processo de autenticação ou de qualquer outro serviço.

Esta função deve registrá-lo no arquivo de configuração avançada? advanced_params.conf ? que está dentro do diretório tuidd / inclui do SDK, definindo os seguintes parâmetros:

â função de retorno de chamada : Exemplo: myCallbackFunction

Nome da função do provedor que será executada no SDK e para a qual os resultados dos serviços do tuidd serão passados. A função deve receber um objeto com os dados por parâmetro.

â callback_function_file Exemplo: 'myfuncs / myfunction.php'

Caminho do arquivo que contém a função de retorno de chamada, definida em callback_function.

Exemplo:

Neste arquivo, uma função de retorno de chamada é implementada. A função pode estar em qualquer parte do seu código, é importante que você indique onde configurar o arquivo de configuração para que o SDK possa levantá-lo

myfunction.php

include_once(' tuidd/tuidd_lib/client/TuiddClient.php '); function myCallbackFunction ( $notification ) { // my callback code ... switch $notification['service_type'] { case 'authentication': // get user information... $userInfo= $notification['notification_data']; // print user information... echo ' Hello '; echo $userInfo['user_info']['name']." ".$userInfo['user_info']['family_name']; echo ' '; echo ' Your ID/:'; echo $userInfo['user_info']['sub']; echo ' '; echo ' Your email is: '; echo $userInfo['user_info']['email']; echo ' '; break; } } ?>

Segurança

O SDK vem com configurações de segurança para o Apache. Se você usar este servidor WEB, você não deve fazer nenhuma configuração adicional para o seu site.

No caso de usar outro servidor da Web, você deve configurar nele que você NÃO tenha acesso aos seguintes diretórios do SDK:

tuidd/ +---conf/ +---docs/ +---includes/ +---lib/ +---language/ +---libs/

Configuração avançada

A configuração é feita seguindo estes passos :

1. Edite o arquivo? advanced_params.conf ? que está dentro do diretório tuidd / inclui do SDK

2. Configure os parâmetros:

â função de retorno de chamada Exemplo: myCallbackFuncion

O nome da função do provedor que será executada no SDK e para a qual os dados do resultado de autenticação serão passados. A função deve receber um objeto com os dados por parâmetro.

â callback_function_file Exemplo: 'myfuncs / myfunction.php'

Caminho absoluto do arquivo que contém a função de retorno de chamada, definida em callback_function.

â escopo : Exemplo: perfil openid

Lista de seqüências de caracteres ASCII - sensível a maiúsculas e minúsculas? com valores do escopo do requisito de autenticação, do padrão OAuth 2.0. De acordo com o padrão, ele deve conter pelo menos o valor openid.

Outros valores possíveis são: perfil, email, endereço, telefone, offline_access, tuidd_notification, tuidd_advertising, tuidd_survey, tuidd_payment, tuidd_coupon.

Por padrão, o SDK solicita todo o usuário.

Para mais informações sobre os valores de scope veja a seção Autenticação do API REST de autenticação .

â security_level Exemplo: 3 2

Os valores de nível de segurança (LOAs) exigidos pelo aplicativo, em ordem de preferência, de acordo com a ISO / IEC 29115 Cláusula 6 "1, 2, 3, 4"representando os níveis LOW, MEDIUM, HIGH e MUITO ALTO, respectivamente. Tenha em mente que o tuidd atualmente suporta apenas os valores 2 e 3. O valor finalmente usado é retornado no campo acr na autenticação.

O valor padrão é 2.

Para obter mais informações, consulte a seção Autenticação da API REST de autenticação.

â tuidd_sdk_path : Exemplo: / my_plugins / tuidd /

Indica em qual diretório relativo à raiz do site o SDK foi instalado.

O valor padrão é 'tuidd /', referindo-se a um local na raiz do site.

â redirect_uri Exemplo: http: //domain/dir/tuidd/index.php

URI absoluto para o qual ele é redirecionado depois que o usuário é autorizado.

Ele deve corresponder ao registrado no site de administração do tuidd, no parâmetro RETURN URL da criação do aplicativo.

â container_div : Exemplo: tuidd-sdk

Id da referência ao wrapper do botão tuidd. Por padrão, o valor é tuidd-sdk

Requisitos

Para usar o SDK, você precisa do seu site para usar os seguintes módulos e versões:

PHP 5+

JQuery 1.8+

Downloads

Versão	v2.0.0
Data	31/01/2020
Descrição	Complemento do SDK para PHP
Compatibilidade	-
Baixar	PHP SDK

Mudanças históricas

v2.0.0	31/01/2020	As referências ao mcg são modificadas pelo tuidd. API de serviços adicionada. Página adicionada para testes de serviço. O ponto final da notificação foi adicionado. O próprio lib jquery é adicionado, para não depender de fontes externas.
v1.0.0	26/01/2018	Primeira versão