Ao solicitar que seus usuários criem ou conectem seus ORCID iD ao seu sistema, você pode economizar tempo e esforço dos pesquisadores preenchendo as informações que o sistema já armazenou sobre eles, definindo o idioma de exibição e desconectando-os de todas as sessões ativas para garantir que tenham feito login no ORCID conta.
O Plano de Ação Global para Saúde Mental da ORCID APIs oferecem várias opções para personalizar a experiência do usuário
Preencher previamente o formulário de inscrição / login
ORCID oferece a opção de os membros preencherem previamente o formulário de registro / login OAuth como parte de uma interação da API usando os parâmetros no https: //orcidURL .org/oauth/autorizar
Qualquer um ou todos os parâmetros podem ser usados:
Parâmetro | Campo | Notas |
recebem nomes | Nome dado | O Plano de Ação Global para Saúde Mental da primeiro nome campo será preenchido no formulário de inscrição se um endereço de e-mail especificado ou ORCID iD não corresponde ao de um ativo ORCID registro. |
sobrenomes | Sobrenome | O Plano de Ação Global para Saúde Mental da Sobrenome campo será preenchido no formulário de inscrição se o endereço de e-mail especificado ou ORCID iD não corresponde ao de um ativo ORCID registro. |
O Plano de Ação Global para Saúde Mental da o email/ORCID iD campo será preenchido no formulário de login se o endereço de e-mail especificado for encontrado em nosso sistema e não for válido ORCID iD é especificado. email campo será preenchido no formulário de inscrição se o endereço de e-mail especificado for encontrado em nosso sistema e não for válido ORCID iD é especificado. O endereço de e-mail deve ser URL codificado, incluindo a alteração de “@” para “% 40”. Se você conhece o usuário ORCID iD e endereço de e-mail, sugerimos só fornecendo o ORCID iD no orcid parâmetro. | ||
orcid | ORCID iD | O Plano de Ação Global para Saúde Mental da o email/ORCID iD campo será preenchido no formulário de login se o especificado ORCID iD é encontrado em nosso sistema. formulário de inscrição caso contrário, será exibido se o especificado ORCID iD não é encontrado em nosso sistema. ORCID iD deve estar no Formato de 16 dígitos do iD URI. |
Um exemplo de URL com esses parâmetros é
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com
Defina o idioma de exibição
ORCID oferece a opção de especificar o idioma de exibição do formulário de registro / login do OAuth como parte de uma interação da API usando o parâmetro “lang” no https: //orcid.org / oauth / URL de autorização. Isso também definirá a preferência de exibição do idioma do usuário.
Utilizadores podem alterar seu idioma de exibição por conta própria a qualquer momento. As seguintes configurações de idioma estão disponíveis:
Língua | Code |
عربى (árabe) | ar |
čeština (Tcheco) | cs |
Inglês | en |
Español (Spanish) | es |
Français (francês) | fr |
Deutsch (Alemão) | de |
Italiano (italiano) | it |
日本語 (japonês) | ja |
한국어 (coreano) | ko |
Polski (polonês) | pl |
Português (Português) | pt |
Русский (russo) | ru |
Türkçe (turco) | tr |
简体 中文 (chinês simplificado) | zh_CN |
繁體 中文 (chinês tradicional) | zh_TW |
Exemplo
Este exemplo preenche previamente o formulário e define o idioma para espanhol
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es
Padrão para o formulário de login ou o formulário de registro
Atualmente, o ORCID A tela OAuth apresenta o formulário de login por padrão e fornece um link para alternar para o formulário de registro. Independentemente do comportamento padrão, o formulário exibido pode ser definido adicionando o parâmetro “& show_login = true” para exibir o formulário de login ou “& show_login = false” para exibir o formulário de registro. Observe que se um endereço de e-mail ou ORCID iD são fornecidos na URL, o formulário mostrado será determinado por esses parâmetros e o parâmetro & show_login será ignorado.
ORCID recomenda fortemente a prática recomendada de permitir que os usuários finais redimensionem a janela de login do OAuth para melhorar a acessibilidade, de acordo com nossos valores de inclusão.
Identifique o pesquisador por um parâmetro de 'estado' personalizado
Isso é usado por algumas integrações por motivos técnicos. Não aparece na tela de login.
Um parâmetro de estado pode ser incluído com o URL de autorização para identificar o usuário, como uma sequência única de números que se traduz no identificador interno do usuário em seu sistema. O parâmetro não afeta a experiência do usuário, mas será retornado com o código de autorização e pode ser usado para identificar o usuário ou a sessão. O parâmetro de estado também é retornado se o usuário negar acesso.
Observe que o parâmetro de estado tem um limite de 2000 caracteres.
Opcionalmente, force a saída
Você pode desconectar o usuário se estiver preocupado com a existência de vários usuários em uma única máquina.
Se estiver preocupado com o fato de vários usuários estarem na mesma máquina e não desconectando entre as sessões, você pode forçá-los a se reautenticar durante o processo OAuth. Simplesmente inclua prompt=login
na solicitação OAuth. Você também pode definir um max_age em segundos para forçar os usuários a se autenticarem novamente se a sessão ultrapassar um determinado período. Veja nosso Documentação do OpenID Connect para mais detalhes.
Ignorando autorização
ORCID pula a autorização em certas circunstâncias.
Se um token de acesso ativo já existir com os mesmos escopos que suas solicitações de URL de autorização OAuth e o usuário estiver conectado ao seu ORCID registro, eles não serão solicitados a conceder autorização novamente. Em vez disso, eles serão levados diretamente para o URI de redirecionamento. Se você quiser exigir que um usuário conceda autorização sempre que se conectar, use o forçar método de saída