Empezando con su integración

solicite solicitar credenciales de API de miembro de sandbox para construir y probar su aplicación. Estas credenciales le permiten realizar llamadas a la API del miembro de la zona de pruebas para leer, escribir y actualizar ORCID registros. El acceso al entorno de prueba de la caja de arena está disponible de forma gratuita para cualquier persona, incluso si no es un ORCID organización miembro.

Nota:: Si está utilizando un sistema de terceros que ya admite ORCID, es posible que no necesite registrarse para obtener las credenciales de la API de sandbox. 

La caja de arena le permite crear cuentas de usuario de prueba y desarrollar su integración sin tener que preocuparse por afectar los datos en vivo (producción) ORCID Registro. El sandbox se comporta de la misma manera que la producción. ORCID Registro con algunas excepciones.

Creando una cuenta de prueba

Para probar el ORCID API y llamadas API, como leer y agregar información a un ORCID registro, también necesitará crear una prueba ORCID grabar en la caja de arena. Esto se puede hacer a través de la interfaz de usuario, al igual que en la producción. ORCID Registro. Ir https://sandbox.orcid.org/register y registrarse para una cuenta.

Direcciones de correo electrónico del remitente

El servidor sandbox envía correos electrónicos de notificación solo a Mailinator (@mailinator.com) direcciones de correo electrónico para no enviar spam a los servidores de correo sin querer. No recibirá un correo electrónico de verificación o una notificación de restablecimiento de contraseña a menos que use una dirección @mailinator.com, y se requiere verificación para realizar modificaciones manuales en los registros de la zona de pruebas. Obtenga más información sobre sus bandejas de entrada públicas de uso gratuito aquí. Si no desea utilizar un Mailinator dirección, luego tome nota de su nombre de usuario y contraseña (ya que los usará para otorgar autorización a su aplicación durante la prueba) y contáctenos para solicitar ayuda con la verificación.

Mailinator es un servicio de correo electrónico que tiene un servicio público gratuito y un servicio privado de pago. Para la prueba puede utilizar el servicio público completamente gratuito. Más información sobre sus niveles aquí.

Mailinator es un servicio de terceros que no es administrado ni mantenido por ORCID. Le recomendamos que revise cómo funciona este servicio y sus limitaciones antes de utilizar estas direcciones. 

Al solicitar permiso para interactuar con un ORCID registro del usuario, usted especifica uno o más 'ámbitos'. Cada alcance le permite hacer ciertas cosas, como leer el registro o actualizar una sección en particular.

Ámbitos de 3 patas (código de autorización)

3 patas se refiere a los tres actores involucrados en la obtención del permiso de un usuario; ORCID, su sistema y el propio usuario.

/autenticar

Este alcance se utiliza para recopilar el ORCID iD y leer información pública en el registro solamente. Todos los demás ámbitos de 3 patas incluyen el permiso de autenticación, por lo que este ámbito se puede omitir si se solicita cualquier otro acceso. Este alcance está disponible en la API pública o miembro.

/ read-limited (solo miembro API)

Este alcance se utiliza para obtener acceso para leer elementos públicos y de visibilidad limitada en un ORCID registro. Este alcance solo está disponible en la API de miembros.

/ actividades / actualización (solo API para miembros)

Este alcance se utiliza para escribir, actualizar y eliminar elementos en las secciones de afiliación, financiación, trabajos y recursos de investigación y revisión por pares de un ORCID registro. Este alcance solo está disponible en la API de miembros.

/ person / update (solo API para miembros)

Este alcance se utiliza para escribir, actualizar y eliminar elementos en las secciones de otros nombres, palabras clave, países, URL de investigadores, sitios web e identificadores externos personales del registro. Este alcance solo está disponible en la API de miembros.

abierto

Este alcance lo utilizan los integradores de OpenID cuando se requiere un id_token. Cuando se incluye el alcance de openid, el Registro devolverá un id_token dentro de la respuesta del token y otorgará permiso al cliente para acceder al punto final de información del usuario para ese usuario. Este alcance está disponible en la API pública y para miembros.

Tenga en cuenta que el alcance 'openid' no comienza con un '/' como el otro ORCID Ámbitos de API. Esto se debe a que el alcance 'openid' no está definido por ORCID, pero en su lugar está definido por la especificación OpenID Connect. Por favor vea nuestro Documentación de OpenID para obtener más información.

Múltiples alcances

Se pueden solicitar múltiples alcances en una sola interacción enumerando los alcances en la URL de autenticación con un espacio codificado entre cada uno, como alcance = / lectura limitada% 20 / actividades / actualización% 20 / persona / actualización

Acceso completo

Si desea acceso completo para leer y editar un registro, incluya tres ámbitos en su URL de autenticación: / lectura limitada, / actividades / actualización y / persona / actualización. En la URL aparecerían como scope = / read-limited% 20 / activities / update% 20 / person / update

Ámbitos de 2 patas (credencial de cliente)

Para algunas actividades, no es necesario pedir permiso al usuario. Los ámbitos de OAuth de dos patas se solicitan directamente desde el ORCID API y no requieren que el investigador otorgue permiso. Los tokens con estos alcances son válidos durante 20 años y se pueden reutilizar

/ read-public

Este alcance se utiliza para leer información pública en un solo ORCID iD o buscar ORCID registros. Este alcance está disponible en la API pública o miembro.

/ webhook

Este alcance permite que una aplicación cliente registre un webhook en un ORCID registro, para recibir notificaciones cuando se actualiza un registro. Este alcance está disponible para premium ORCID solo miembros. Si no es un miembro premium, pero desea probar esta función en la zona de pruebas del desarrollador, contacto ORCID Comunidad.

• En el pasado ORCID admitido otros ámbitos, que ahora han sido eliminado.
• Puedes averiguarlo qué ámbitos son necesarios para agregar o actualizar secciones en particular aquí.

Las integraciones deben almacenar más que solo ORCID registros. Su sistema deberá poder:

• Aceptar y almacenar ORCID iDs: Su sistema necesitará conocer el iD de la ORCID registro para actualizar. Guárdelo junto con la información del investigador. Nuestra recomendación es almacenar el URI https completo: https://orcid.org/0000-0001-5727-2427.
• Aceptar y almacenar persistente tokens de acceso y actualizar tokens: Los tokens de acceso se pueden utilizar para leer y actualizar registros, así como para indicar que iD ha sido autenticado. Los tokens persistentes tienen una validez de aproximadamente 20 años o hasta que el usuario los revoque. Los tokens de actualización se pueden usar para crear nuevos tokens de acceso con alcances iguales o limitados. Guarde las fichas junto con la información del investigador. También le recomendamos que guarde el alcance del token, y el,caducidad del token.
• Aceptar y almacenar poner códigos (si actualiza ORCID registros): cada elemento que agregue al ORCID El registro será devuelto con un código put por el ORCID API. Guarde este código de colocación junto con el elemento en su sistema, así es como identificará qué elemento debe leerse o actualizarse.
• Registrar interacciones: su sistema debe registrar ambas llamadas realizadas al ORCID API y respuestas recibidas. Esto es necesario entonces ORCID puede ayudar si se desarrolla un problema más adelante.
• Proporcione mensajes de error y un contacto de soporte cuando una interacción no sea la esperada.

Para asegurarse de construir la mejor integración posible para su institución, sus investigadores y la comunidad en general, le recomendamos que considere las siguientes mejores prácticas:

• Personaliza la experiencia del usuario: Utilice los datos que su sistema ha almacenado para completar previamente la pantalla de inicio de sesión / registro de OAuth. También puede incluir parámetros de estado para identificar al usuario en su sistema o cambiar el idioma de visualización en ORCID.
• Proporcione un flujo de trabajo para los usuarios si niegan el permiso de su sistema: proporcione un mensaje a los usuarios que explique claramente qué ORCID es por qué su sistema solicita permiso a su ORCID registro, y lo que hará con ese permiso, y ofrecer la opción de otorgar nuevamente el permiso.
• Proporcione una opción para que los usuarios eliminen sus ORCID iD y datos de su sistema: en casos excepcionales, es posible que un usuario desee eliminar su iD de su sistema, o puede que hayan conectado el ORCID iD Asegúrese de que su sistema también revoque cualquier token de acceso activo al mismo tiempo.
• Actualice los artículos agregados cuando se necesiten correcciones usando el código único de colocación del artículo.
• Proporcione mensajes de error descriptivos y un contacto de soporte a sus usuarios cuando una interacción no sea la esperada.
• Mostrar el ORCID logotipo de miembrocontáctenos para recibirlo)
• Cree una experiencia de usuario coherente asociando el iD icono con un proceso de afirmación confiable. Nuestra ORCID Directrices de marca para miembros y socioss le guiará por el proceso de configuración de la pantalla del iD icono en su sistema, así como un resumen de lo que se debe y no se debe hacer para mostrar el ORCID marca.
• Use el token de acceso para verificar los permisos existentes: una vez que haya recibido los permisos del usuario una vez, no debería necesitar solicitarlos nuevamente.

Para apoyar el componente social, ofrecemos un conjunto de herramientas de Recursos de divulgación para ayudarlo a desarrollar una campaña para respaldar su integración y comunicar a sus investigadores:

• Qué ORCID .
• Por qué su sistema recopila iD y cómo realizará las tareas, como actualizar sus registros.
• Por qué sus investigadores se beneficiarán al crear un ORCID iD y conectar sus iD a su sistema.
• ¿Cómo ORCID beneficia a la comunidad de investigación global más amplia.

Continuamente estaremos construyendo esta “biblioteca” de recursos basados ​​en los comentarios de la comunidad. Si tiene una idea de algo que le gustaría ver, no dude en contactarnos.

Solicitud de organizaciones miembro ORCID Credenciales de API de miembro en el servidor de producción (en vivo) completando el Formulario de solicitud de cliente de API de miembro de producción. Antes de emitir las credenciales de API de miembro de producción, ORCID El equipo de participación revisará una demostración de su integración en el ORCID salvadera. Esto nos da la oportunidad de ver las excelentes integraciones que ha creado y ofrecer mejoras en el flujo de trabajo, así como verificar que todas las integraciones cumplan con nuestras mejores prácticas.

Para proporcionar una demostración de su sistema, deberá configurar una integración de trabajo con el ORCID caja de arena que el ORCID el equipo puede obtener una vista previa. Hay algunas formas de compartir su integración de sandbox de trabajo:

1. Recomendado: Demo en vivo: Contáctenos para programar una demostración en vivo. Le proporcionaremos un software para reuniones que le permitirá compartir su pantalla para que pueda hacer una demostración de su integración. Esto también nos da la oportunidad de aprender más sobre cómo funciona su sistema y cómo está explicando los beneficios de su ORCID integración, para que podamos brindarle un mejor soporte a usted y a sus usuarios.
2. Sitio de prueba: Si su sitio de desarrollo es público, envíanos la URL junto con las credenciales de prueba (si es necesario) para acceder a su sistema e instrucciones que describen cómo utilizar las ORCID características. Proporcione documentación adicional para verificar lo que no podríamos ver desde el extremo del usuario, por ejemplo, la versión de API utilizada, qué datos almacena su sistema, etc.
3. Screencast o capturas de pantalla (recomendado para ORCID-sistemas habilitados que requieren una demostración): Envía una grabación o un conjunto de capturas de pantalla con descripciones que explican y demuestran claramente cómo funciona su integración en cada paso, incluido lo que sucede si un usuario niega el acceso o desconecta su iD. Asegúrese de proporcionar documentación adicional para verificar cualquier cosa que no podamos ver desde el extremo del usuario, como la versión de API utilizada y cómo se almacenan los datos.¬¨‚

Si está utilizando uno de los ORCID-sistemas habilitados que no requieren una demostración, puede directamente solicitar credenciales de API de miembro de producción. Asegúrese de especificar qué sistema (y, si corresponde, versión) está utilizando en las notas.

Hay una serie de requisitos que esperamos que cumplan todas las integraciones de miembros. La ORCID El equipo se asegurará de que se cumplan estos requisitos como parte del proceso de revisión de la integración. 

• Utilice la herramienta OAuth autenticar ORCID iDs (no permitir que los usuarios busquen o escriban ORCID ID.)
• Incluir un ORCID botón o enlace de marca en su sitio para iniciar la autenticación del iD.
• Presente la pantalla de autorización de OAuth de acuerdo con nuestra orientaciones
• Utilice HTTPS para los URI de redireccionamiento de su sitio y en ORCID Llamadas API
• Acepte y almacene todos los datos devueltos en el intercambio de tokens junto con los datos del usuario en su sistema
• Use apropiado alcances y métodos de solicitud (por ejemplo, llamadas POST para agregar nueva información y llamadas PUT para actualizar la información existente)
• Mostrar públicamente el autenticado ORCID iDs. Las identificaciones deben mostrarse después de nuestra marca registrada y iD mostrar las pautas.

Mejores prácticas

Asegúrese de que su integración siga las mejores prácticas

Deberá completar el formulario para registrar una solicitud de cliente. A continuación se muestra una descripción general rápida de los campos solicitados:

Notas para ORCID personal: Utilice este campo para permitir ORCID saber si está utilizando un sistema de proveedor, si se han revisado las integraciones, etc.

Correo electrónico de contacto: Enviaremos las credenciales a esta dirección. Este debe ser el contacto con el que hemos estado trabajando en la integración o el contacto técnico que tenemos para su organización.

Contacto para recibir PIN para acceder a las credenciales: Le enviamos las credenciales completas de forma segura. Enviaremos un código de acceso para acceder a sus credenciales de API a este contacto. Este debe ser un contacto diferente al contacto anterior enumerado.

Breve descripción de su aplicación cliente: Este texto se mostrará en la pantalla de autorización con el icono de un signo de interrogación para sus usuarios de integración. Se requiere una breve descripción de su integración.

URL de la página de inicio de su aplicación: Se muestra como un enlace en la lista de organizaciones de confianza dentro de los usuarios ORCID página de partes de confianza. Debe ser un enlace a su organización o a la página principal de su aplicación.

OAuth2 redirecciona URI o URL de devolución de llamada para el cliente: URL permitidas en su aplicación web a las que se devolverá a los usuarios después de que autoricen el acceso a sus ORCID registrar datos. Todos los URI de redireccionamiento deben ser HTTPS para los clientes del servidor de producción (en vivo). 

Una vez que haya realizado su solicitud, se realizará un proceso manual para emitir sus credenciales y recibirá un correo electrónico con su cliente. iD y secreto del cliente. Normalmente, estas solicitudes se procesan en menos de 48 horas.