ORCID ofrece varias API que permiten que sus sistemas se conecten a la ORCID registro, incluida la lectura y la escritura en ORCID registros. Algunas funciones de la API están disponibles gratuitamente para cualquier persona (Public API); otros solo están disponibles para ORCID organizaciones miembrosAPI para miembros y miembros premium). Cualquiera es libre de probar cualquiera de nuestras API en nuestro servidor de pruebas sandbox.
Antes de que empieces
Al comenzar con la planificación de la integración, debe considerar:
- ¿Qué quieres hacer con el ORCID API: visite nuestro flujos de trabajo y mejores prácticas de integración. Si eres un ORCID organización miembro, puede comunicarse con nosotros o con el líder de su consorcio para obtener ayuda. .
- Si está utilizando un sistema que ya admite ORCID. Si es así, puede ser tan simple como configurar su sistema para trabajar con ORCID. Por favor, consulte nuestro ORCID listado de proveedores de servicios certificados para ver si su sistema está incluido
- Cómo se comunicará con sus investigadores sobre los cambios que se están implementando, lo que necesitará de ellos, los beneficios para ellos y lo que deberán hacer. Visita nuestro Recursos de divulgación página para obtener ideas sobre cómo crear una campaña de comunicaciones en torno a su nueva integración. También le recomendamos que vea nuestro seminario web '¡¿Soy miembro y ahora qué?! como hablar de ORCID'
Regístrese para obtener las credenciales de la zona de pruebas y cree una prueba ORCID iD
Si está creando una integración personalizada o utilizando una aplicación de proveedor de servicios no certificado, primero le solicitaremos que utilice nuestro entorno Sandbox para crear y probar su integración.
Podés solicitar credenciales de API de miembro de sandbox para construir y probar su aplicación. Estas credenciales le permiten realizar llamadas a la API de miembro premium de Sandbox 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 ORCID sistema de proveedor de servicios certificado que ya admite ORCID, no necesita registrarse para obtener las credenciales de la API de sandbox a menos que desee probar la ORCID funcionalidad de integración dentro del entorno 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 solo envía correos electrónicos 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 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.
Determine los permisos de usuario que necesitará
La ORCID La API de miembros se puede usar para leer, agregar o actualizar información en la cuenta de un usuario. ORCID registro: solo necesita solicitar permiso a sus investigadores.
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.
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, actividades profesionales, 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 identificación, buscar ORCID registros o para leer información resumida (solo API para miembros). Este alcance está disponible en la API pública o para miembros.
/ 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.
Asegúrese de poder almacenar los datos de forma segura
Es importante que su sistema pueda almacenar información de manera segura.
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 del sistema ORCID grabar para mostrar el iD y actualizarse correctamente. Guárdelo junto con la información del investigador que se devuelve en la respuesta del intercambio de tokens. 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 de acceso tienen una validez aproximada de 20 años o hasta que el usuario los revoque. También le recomendamos guardar el alcance del token, caducidad del token y actualizar tokens. Los tokens de actualización se pueden utilizar para crear nuevos tokens de acceso con el mismo alcance o uno limitado si es necesario. Almacene los datos del token de acceso junto con la información del investigador.
- Aceptar y almacenar poner códigos : Cada elemento que agregas al ORCID El registro será devuelto con un código put por el ORCID API. Guarde este código de colocación de 6 dígitos junto con el elemento en su sistema; así identificará qué elemento debe leerse, actualizarse o eliminarse.
- Proporcione mensajes de error y un contacto de soporte cuando una interacción no sea la esperada.
Consulte con el ORCID equipo o su líder de consorcio para demostrar cómo funciona su aplicación
Antes de que su integración pueda comenzar a funcionar en el ORCID registro de producción, nuestro Equipo de Compromiso o su Líder de Consorcio verificarán que todo lo que haya creado en el sandbox también funcionará en producción. Si estás usando un ORCID Sistema de proveedor de servicios certificado, este paso se puede omitir. Tenemos una lista de requisitos mínimos que deben cumplirse antes de que podamos emitir credenciales de producción de API para miembros.
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 compromiso/líder de consorcio 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 y requisitos mínimos para el lanzamiento.
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:
- 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 demostrar su integración.
- 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.
- Screencast o capturas de pantalla: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 qué sucede si un usuario niega el acceso o desconecta su identificación. Asegúrese de proporcionar documentación adicional para verificar cualquier cosa que no podamos ver desde el lado del usuario, como la versión de API utilizada y cómo se almacenan los datos.
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ónSi está utilizando un sistema de proveedor que no está en la lista de ORCID Proveedores de servicios certificados, su integración deberá pasar por un proceso de revisión para garantizar que la Requisitos mínimos para la integración y mejores prácticas se cumplan.
Puede ponerse en contacto con su proveedor de servicios no certificado y obtener evidencia directamente de que se cumplen los criterios mínimos. Deberá enviar esta evidencia al proveedor de servicios no certificado. ORCID Equipo de participación o líder de su consorcio.
Hay algunas formas de compartir esta evidencia:
- Capturas de pantalla o screencast: Envíe una grabación o un conjunto de capturas de pantalla con descripciones que expliquen y demuestren 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 lado del usuario, como la versión de API utilizada y cómo se almacenan los datos.
- Documentación de integración disponible públicamente: Envíe un enlace actualizado y de acceso público que incluya una descripción clara de cómo funciona la integración en cada paso. Al igual que en la opción 1, asegúrese de proporcionar documentación adicional para verificar cualquier aspecto que no podamos ver desde el lado del usuario, como la versión de API utilizada y cómo se almacenan los datos.
Solicitar credenciales de API de miembro
Puede solicitar las credenciales de la API de miembro una vez que su integración haya sido revisada por el ORCID equipo o si está utilizando un ORCID sistema de proveedor de servicios certificado.
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:
Nombre de la organización: Tu ORCID nombre de la organización miembro
Dirección de correo electrónico de contacto principal para credenciales: Usaremos esta dirección de correo electrónico para enviarle las credenciales en un correo electrónico cifrado y para comunicarnos con usted si surge alguna pregunta o error con su integración.
Correo electrónico secundario para contraseña: Una dirección de correo electrónico a la que podemos enviar su contraseña de correo electrónico cifrada.
Nombre de su cliente: Esta sera tu ORCID nombre de la organización miembro. Si tiene más de una integración, agregaremos la aplicación al nombre.
URL de la página de inicio de su aplicación: Se muestra como un enlace en la lista de organizaciones confiables 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.
Breve descripción de su aplicación cliente: Este texto se mostrará en la pantalla de autorización con el icono del signo de interrogación a sus usuarios de integración. Se requiere una breve descripción de su integración.
Redirigir URI: Una vez que el usuario haya autorizado su aplicación, será devuelto a un URI que especifique. Debe proporcionar estos URI por adelantado o sus usuarios de integración experimentarán un error.
- Solo se aceptan URI de HTTPS.
- Los dominios registrados deben coincidir exactamente con los dominios utilizados, incluidos los subdominios.
- Registre todos los URI de redirección completos cuando sea posible.
- ¿Se requieren más de 5 URI de redirección? Indique esto en las Notas para ORCID de los empleados.
Notas para ORCID personal: Utilice este campo para permitir ORCID El personal sabe algo adicional sobre su solicitud o su integración.
Transfiera su solicitud al ORCID Registro de producción
Una vez que tenga sus credenciales, estará listo para implementar su integración. Si desea probar su integración antes de que se lance al público, utilice el propio probador. ORCID registro o de un colega ORCID registro.
Lanzar y dejar que todos sepan
Poner en marcha una aplicación no es el último paso; necesita seguir comunicándose con sus usuarios para que sepan conectar ORCID iD a su sistema de forma rápida y sencilla. Las integraciones efectivas contienen tanto un componente técnico (que cubre esta guía) como un componente social. Los investigadores deben estar informados sobre qué ORCID es por qué solicita acceso a su ORCID registro, y lo que hará con sus datos.
- Cree un cronograma de comunicación: asegúrese de que las partes interesadas estén al tanto de su ORCID proyecto mucho antes de su lanzamiento.
- Utilice una combinación de comunicaciones de arriba hacia abajo y de abajo hacia arriba.
- Promociona tu ORCID integración a menudo y a diferentes públicos.
- Crea recursos locales para ayudar a sus usuarios, como preguntas frecuentes, guías de biblioteca, páginas web, tutoriales y videos.
- Designe a una persona de contacto local para ORCID-preguntas relacionadas.
Si necesita ayuda, comuníquese con su líder de participación o su líder de consorcio.
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:
- Que 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.