DocID®Documentação do DocID®
Voltar ao DocID®
  • Visão geral

    • Documentação do DocID®
  • Introdução

    • Introdução
    • Como funciona o DocID®
    • Conceitos fundamentais
  • Primeiros passos

    • Primeiros passos
    • Módulo Drupal
    • Plugin WordPress
    • Site personalizado
    • Checklist de entrada em produção
  • Funcionalidades

    • Funcionalidades
    • Standard Login
    • Acesso e personalização
    • Analytics
    • Campaigns
  • Licenças

    • Licenças
  • OAuth 2.0

    • OAuth 2.0
    • Configurar um cliente
    • Fluxo Authorization Code
    • Scopes e UserInfo
    • Segurança e ambientes
  • API

    • API
  • Ajuda

    • Resolução de problemas

Primeiros passos

Plugin WordPress

Ligue o WordPress ao DocID®, proteja conteúdo e utilize atributos profissionais verificados em fluxos nativos.

O plugin oficial DocID® liga o WordPress a uma das maiores redes online de profissionais de saúde. Protege artigos, páginas, tipos de conteúdo personalizados e conteúdos multimédia e pode integrar identidades profissionais verificadas com utilizadores, funções, menus e conteúdo nativos do WordPress.

Abrir o plugin DocID® no WordPress.org

Pré-requisitos

  • Um site WordPress com HTTPS e acesso de administrador
  • Uma conta DocID® com um asset de site configurado e credenciais OAuth
  • Uma cópia de segurança e um ambiente de staging para validar temas, plugins e regras de acesso específicos do site

Instalar o plugin

Através da administração do WordPress

Abra Plugins → Adicionar novo → Carregar plugin, selecione o arquivo atual do plugin DocID®, instale-o e escolha Ativar plugin.

Com WP-CLI

Instale e ative um arquivo local a partir da raiz do WordPress:

wp plugin install /path/to/docid.zip --activate

Configurar OAuth e os dados de clientes solicitados

  1. Abra Definições → DocID® → Credenciais OAuth.
  2. Copie o URL de callback apresentado para os URI de redirecionamento permitidos do asset correspondente no painel empresarial DocID®.
  3. Introduza o Client ID e o Client Secret do asset.
  4. Em Dados de clientes solicitados, mantenha openid e professional e ative apenas os dados opcionais profile, email ou phone de que o site necessita.

Scopes disponíveis

ScopeEstadoClaims
openidObrigatóriosub
professionalObrigatórioprofession_id, discipline_id, profession_verified
profileOpcionalname, title, given_name, family_name, gender
emailOpcionalemail
phoneOpcionalphone_number

Contas WordPress nativas opcionais

Ative o aprovisionamento nativo apenas quando funções, capacidades ou integrações do WordPress precisarem de um utilizador atual nativo. Os novos utilizadores recebem um nome estável e não pessoal e são associados apenas pelo subject DocID® imutável, nunca automaticamente por e-mail. A sincronização opcional do e-mail ativa automaticamente o scope email opcional. A barra de administração pode ser ocultada separadamente para utilizadores DocID® aprovisionados sem afetar outros utilizadores do WordPress. As funções locais atribuídas fora do DocID® permanecem inalteradas.

Mapeamentos de funções

Associe todos os utilizadores DocID® ou identificadores exatos de profissão, disciplina, instituição ou tema a uma ou mais funções não administrativas do WordPress. Os mapeamentos correspondentes são combinados e podem ser adicionados, editados ou removidos na tabela.

Proteção de conteúdo

Use o painel de início de sessão DocID® nos ecrãs de edição suportados para proteger artigos, páginas, tipos de conteúdo personalizados ou multimédia. O separador Proteção de conteúdo oferece uma vista paginada, pesquisável e filtrável por tipo de conteúdo, com ligações diretas de edição.

Destinos de início de sessão

Configure destinos locais por profissão ou disciplina. O número de prioridade mais baixo prevalece. O conteúdo solicitado antes da autenticação tem sempre prioridade sobre um destino baseado no perfil.

Shortcodes disponíveis

Adicione Navegação da conta a um menu do WordPress ou use os shortcodes abaixo em conteúdos, widgets e campos compatíveis de construtores de páginas.

Autenticação e navegação

A ligação de início de sessão adapta-se ao estado: apresenta iniciar sessão aos visitantes e terminar sessão aos utilizadores DocID® autenticados. Os atributos login_text e logout_text personalizam ambos os rótulos. O nome de utilizador usa o melhor valor disponível por esta ordem: título, nome próprio e apelido; título e apelido; e-mail autorizado; ID de utilizador DocID® estável.

ShortcodeDescrição
[docid-account-navigation]Mostra Iniciar sessão aos visitantes. Aos utilizadores DocID® autenticados, mostra o melhor nome de utilizador disponível seguido de | Terminar sessão.
[docid-loggedin-content]Content[/docid-loggedin-content]Mostra o conteúdo incluído apenas a utilizadores DocID® autenticados.
[docid-loggedout-content]Content[/docid-loggedout-content]Mostra o conteúdo incluído apenas a visitantes sem uma sessão DocID® autenticada.
[docid-login-link]Mostra Iniciar sessão aos visitantes e Terminar sessão aos utilizadores DocID® autenticados.
[docid-login-link login_text="Access" logout_text="Leave"]Utiliza rótulos de texto personalizados para ambos os estados de autenticação.
[docid-username]Mostra o melhor nome de utilizador disponível: título, nome próprio e apelido; depois título e apelido; depois o endereço de e-mail autorizado; e, por fim, o ID de utilizador DocID® estável.

Dados de perfil

ShortcodeScopeDescrição
[docid-profile-id]openid (obrigatório)O identificador estável e único da conta DocID®.
[docid-profile-name]profile (opcional; autorização necessária)O título, o nome próprio e o apelido combinados.
[docid-profile-title]profile (opcional; autorização necessária)O título ou a forma de tratamento.
[docid-profile-given-name]profile (opcional; autorização necessária)O nome próprio.
[docid-profile-family-name]profile (opcional; autorização necessária)O apelido.
[docid-profile-gender]profile (opcional; autorização necessária)O valor de género.
[docid-profile-email]email (opcional; autorização necessária)O endereço de e-mail transferido, quando disponível.
[docid-profile-phone-number]phone (opcional; autorização necessária)O número de telefone transferido, quando disponível.

Aceder ao estado de autenticação e aos claims em PHP

A API Base pública pode ler a sessão DocID® atual sem exigir o aprovisionamento nativo do WordPress. Os valores opcionais só existem quando o respetivo scope foi solicitado, autorizado e devolvido.

Ler a identidade atual e os claims transferidos
$docid = new \DOCID\Includes\DOCID_Base();$is_docid_authenticated = $docid->docid_is_loggedin();$identity = $docid->docid_get_user(); $docid_subject = is_array($identity) ? ($identity['id'] ?? NULL) : NULL;$profession_id = is_array($identity) ? ($identity['profession_id'] ?? NULL) : NULL;$discipline_id = is_array($identity) ? ($identity['discipline_id'] ?? NULL) : NULL;$institution_id = is_array($identity) ? ($identity['institution_id'] ?? NULL) : NULL;$subject_id = is_array($identity) ? ($identity['subject_id'] ?? NULL) : NULL;$profession_verified = is_array($identity)  ? (bool) ($identity['profession_verified'] ?? FALSE)  : FALSE; // Optional values exist only when their scope was authorized.$name = is_array($identity) ? ($identity['name'] ?? NULL) : NULL;$email = is_array($identity) ? ($identity['email'] ?? NULL) : NULL;$phone = is_array($identity) ? ($identity['phone'] ?? NULL) : NULL;$wordpress_user_id = is_array($identity)  ? ($identity['wordpress_user_id'] ?? NULL)  : NULL;

Testar antes do lançamento

  1. Abra conteúdo público e protegido sem iniciar sessão.
  2. Conclua o início de sessão com uma conta de teste elegível e confirme o regresso ao conteúdo inicialmente solicitado.
  3. Continue sem dados de perfil opcionais e confirme que a autenticação funciona com os scopes obrigatórios.
  4. Teste cada mapeamento de função e destino de início de sessão, incluindo uma conta sem correspondência.
  5. Termine a sessão e confirme que o conteúdo protegido deixou de estar acessível.

A integração fornece funções técnicas de autenticação e controlo de acesso. Os operadores do site continuam responsáveis pela escolha dos scopes, permissões, avisos e bases jurídicas adequados à sua implementação.

AnteriorMódulo DrupalSeguinteSite personalizado

Nesta página

  1. Pré-requisitos
  2. Instalar o plugin
  3. Através da administração do WordPress
  4. Com WP-CLI
  5. Configurar OAuth e os dados de clientes solicitados
  6. Scopes disponíveis
  7. Contas WordPress nativas opcionais
  8. Mapeamentos de funções
  9. Proteção de conteúdo
  10. Destinos de início de sessão
  11. Shortcodes disponíveis
  12. Autenticação e navegação
  13. Dados de perfil
  14. Aceder ao estado de autenticação e aos claims em PHP
  15. Testar antes do lançamento