Al solicitar a sus usuarios que creen o conecten sus ORCID iD a su sistema, puede ahorrar tiempo y esfuerzo a sus investigadores completando la información que su sistema ya ha almacenado sobre ellos, configurando su idioma de visualización y cerrándolos en cualquier sesión activa para asegurarse de que hayan iniciado sesión en el ORCID cuenta.
El ORCID Las API ofrecen varias opciones para personalizar la experiencia del usuario.
Rellene previamente el formulario de registro / inicio de sesión
ORCID ofrece la opción para que los miembros completen previamente el formulario de registro/inicio de sesión de OAuth como parte de una interacción API utilizando los parámetros en la URL https://orcid.org/oauth/authorize
Se pueden utilizar todos o cualquiera de los parámetros:
| Parámetro | Campo | Notas |
| nombres dados | Nombre de pila | El Nombre de pila El campo se completará en el formulario de inscripción si una dirección de correo electrónico especificada o ORCID iD no coincide con el de un activo ORCID registro. |
| apellidos | Apellido | El apellido El campo se completará en el formulario de inscripción si la dirección de correo electrónico especificada o ORCID iD no coincide con el de un activo ORCID registro. |
| correo electrónico | Correo electrónico | El correo electrónico/ORCID iD El campo se completará en el formulario de inicio de sesión si la dirección de correo electrónico especificada se encuentra en nuestro sistema y no es válida ORCID iD se especifica. correo electrónico El campo se completará en el formulario de inscripción si la dirección de correo electrónico especificada se encuentra en nuestro sistema y no es válida ORCID iD La dirección de correo electrónico debe ser URL codificada, incluido el cambio de "@" a "% 40". Si conoce el usuario ORCID iD y dirección de correo electrónico, sugerimos only proporcionando el ORCID iD en el parámetro orcid. |
| orcido | ORCID iD | El correo electrónico/ORCID iD El campo se completará en el formulario de inicio de sesión si el especificado ORCID iD se encuentra en nuestro sistema. formulario de inscripción de lo contrario, se mostrará si el especificado ORCID iD no se encuentra en nuestro sistema. ORCID iD debe estar en el Formato de 16 dígitos del iD URI. |
Un ejemplo de URL con estos parámetros es
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
Establecer el idioma de la pantalla
ORCID ofrece la opción de especificar el idioma de visualización del formulario de registro/inicio de sesión de OAuth como parte de una interacción de API mediante el parámetro “lang” en la URL https://orcid.org/oauth/authorize. Esto también establecerá la preferencia de idioma de visualización del usuario.
Usuarios puede cambiar su idioma de visualización por su cuenta en cualquier momento. Están disponibles las siguientes configuraciones de idioma:
| Idioma | Código |
| عربى (árabe) | ar |
| čeština (checo) | cs |
| Inglés | en |
| Español (Español) | es |
| Français (French) | fr |
| Deutsch (alemán) | de |
| Italiano (italiano) | it |
| 日本語 (japonés) | ja |
| 한국어 (coreano) | ko |
| Polski (polaco) | pl |
| Português (Portugués) | pt |
| Русский (ruso) | ru |
| Türkçe (turco) | tr |
| 简体 中文 (chino simplificado) | zh_CN |
| 繁體 中文 (chino tradicional) | zh_TW |
Ejemplo
Este ejemplo rellena previamente el formulario y establece el idioma en español.
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 Predeterminado para el formulario de inicio de sesión o el formulario de registro
Actualmente, el ORCID La pantalla de OAuth presenta el formulario de inicio de sesión de forma predeterminada y proporciona un enlace para cambiar al formulario de registro. Independientemente del comportamiento predeterminado, el formulario que se muestra se puede configurar agregando el parámetro "& show_login = true" para mostrar el formulario de inicio de sesión o "& show_login = false" para mostrar el formulario de registro. Tenga en cuenta que si una dirección de correo electrónico o ORCID iD se proporcionan en la URL, el formulario mostrado será determinado por esos parámetros y el parámetro & show_login será ignorado.
ORCID recomienda encarecidamente la mejor práctica de permitir a los usuarios finales cambiar el tamaño de la ventana de inicio de sesión de OAuth para mejorar la accesibilidad, de acuerdo con nuestros valores en torno a la inclusión.
Identificar al investigador mediante un parámetro de 'estado' personalizado
Esto es utilizado por algunas integraciones por razones técnicas. No aparece en la pantalla de inicio de sesión.
Se puede incluir un parámetro de estado con la URL de autorización para identificar al usuario, como una secuencia única de números que se traduce en el identificador interno del usuario dentro de su sistema. El parámetro no afecta la experiencia del usuario, pero se devolverá con el código de autorización y se puede utilizar para identificar al usuario o la sesión. El parámetro de estado también se devuelve si el usuario deniega el acceso.
Tenga en cuenta que el parámetro de estado tiene un límite de 2000 caracteres.
Opcionalmente, forzar el cierre de sesión
Puede cerrar la sesión del usuario si le preocupa que haya varios usuarios en una sola máquina.
Si le preocupa que varios usuarios estén en la misma máquina y no cierren sesión entre sesiones, puede obligarlos a volver a autenticarse durante el proceso de OAuth. Simplemente incluye prompt=login en la solicitud de OAuth. También puede establecer un max_age en segundos para obligar a los usuarios a volver a autenticarse si su sesión supera una determinada duración. Ver nuestro Documentación de OpenID Connect para obtener más información.
Saltar autorización
ORCID omite la autorización en determinadas circunstancias.
Si ya existe un token de acceso activo con los mismos alcances que solicita su URL de autorización de OAuth, y el usuario ha iniciado sesión en su ORCID registro, no se les pedirá que vuelvan a otorgar la autorización. En su lugar, se llevarán directamente al URI de redireccionamiento. Si desea solicitar a un usuario que otorgue autorización cada vez que se conecta, utilice la Forzar el método de cierre de sesión