Cosas que debe completar antes de comenzar
Antes de que pueda comenzar con este tutorial, debe haber completado los 3 pasos a continuación:
- Solicitar credenciales de API para miembros de Sandbox
- Crear una caja de arena ORCID cuenta
- Configura tu área de juegos de google oauth
Para este tutorial, usaremos ORCIDentorno de prueba, el ORCID Salvadera. El Sandbox funciona igual que la producción. ORCID Registro, con algunas excepciones:
- Sandbox solo envía correos electrónicos a mailinator.com direcciones
- La mayoría de las herramientas del asistente de importación no funcionan en Sandbox.
- Los enlaces del menú al contenido informativo (Acerca de, Para investigadores, Membresía, etc.) no funcionan en Sandbox
- Sandbox no contiene ningún dato de producción
Solicitar credenciales de API para miembros de Sandbox
Las credenciales de la API consisten en un Identificación del cliente y comprador secreto que se necesitan para recopilar iD autenticados y/o permisos de usuario para interactuar con sus ORCID registro. Solicite sus credenciales de Sandbox aquí. Agregue una nota para informar que está probando con Google OAuth Playground. Tenga en cuenta que este es un proceso manual y puede tomar hasta 24 horas para que se creen las credenciales.
Crear una caja de arena ORCID cuenta
En una nueva ventana o pestaña, visite https://sandbox.orcid.org/register
- Ingrese su nombre y dirección de correo electrónico, y luego haga clic en el botón "siguiente". ¡IMPORTANTE! ¡No utilices una dirección de correo electrónico real! En su lugar, crea una dirección que termine en @mailinator.com
- Complete el paso 2 del formulario de registro con una contraseña y continúe con el paso 3.
- Seleccione su configuración de visibilidad preferida, acepte los términos de uso, haga clic en el cuadro junto al texto "No soy un robot" y finalmente haga clic en el botón "registrarse".
Recuerde el correo electrónico y la contraseña: ¡los necesitará durante todo el tutorial!
Configure su Zona de juegos de Google OAuth
- Ve a Zona de juegos de Google OAuth
- Haga clic en el ícono de ajustes en la esquina superior derecha para abrir el Configuración de OAuth 2.0
- Cambie el menú desplegable Puntos finales de Oauth a Personalizado e ingrese la siguiente configuración y haga clic en Cerrar
¡Importante! Mantenga abierto Google OAuth Playground para no perder las configuraciones que ha realizado en los pasos anteriores. También puede guardar la URL que le permite inicializar Playground con estas configuraciones (para obtener la URL, haga clic en el icono de enlace junto al icono de engranaje en la esquina superior derecha).
Recopilación autenticada ORCID iDs y permisos
ORCID las integraciones utilizan “OAuth de 3 patas” para autenticar a los usuarios y solicitar permiso para interactuar con sus registros. Cualquier integración puede solicitar permisos de lectura utilizando la API pública. ORCID los miembros pueden usar la API de miembros para solicitar permisos de lectura y escritura.
En esta sección, veremos los pasos que su propia integración personalizada debería completar para obtener una autenticación iD y permiso para leer y escribir en un ORCID grabar
Obtener un autenticado iD y registrar el permiso de acceso de un usuario implica seguir OAuth 2.0, un protocolo estándar de la industria para la autorización. OAuth le permite a un usuario dar acceso a un sitio web o aplicación a la información de la cuenta almacenada en otro sitio, sin darle a ese sitio su contraseña.
Si alguna vez ha iniciado sesión en un sitio usando Google o Facebook en lugar de sus credenciales para ese sitio en particular, ¡ya ha usado OAuth!
El proceso de OAuth incluye 3 pasos:
- Crear una URL de autorización
- Obtener un código de autorización
- Canjea el código de autorización por un token de acceso
Para iniciar el proceso de OAuth, necesitaremos crear una URL de autorización especial que envíe a los usuarios a un ORCID pantalla de inicio de sesión. Esta URL consta de Extremo de autorización, además de parámetros que identifican a su organización y los permisos que desea solicitar.
Para solicitar permiso para agregar/actualizar actividades (afiliaciones, financiación, trabajos, revisión por pares, recursos de investigación) y para agregar/actualizar elementos personales (otros nombres, palabras clave, países, URL de investigadores, sitios web e identificadores externos personales), el URL de autorización será:
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplaygroundPero podemos usar el área de juegos de Google OAuth para ayudarnos a construir la URL de autorización
Agregue /actividades/actualización, /persona/actualización, /lectura limitada en el campo de alcances y haga clic en autorizar API.
La URL de autorización se habría creado utilizando la información que ingresó en los campos de configuración y alcance.
An ORCID aparecerá la pantalla de inicio de sesión; inicie sesión en su cuenta de Sandbox con la dirección de correo electrónico y la contraseña que utilizó para crear su ORCID cuenta al comienzo de este tutorial. Una vez que haya iniciado sesión, aparecerá la pantalla OAuth. El nombre del cliente y los ámbitos relevantes que se incluyeron en la URL de autorización se mostrarán en esta pantalla. Para otorgar acceso, debe hacer clic en 'Autorizar acceso'
Después de otorgar el permiso, será redirigido de nuevo a Google OAuth Playground, ya que este era el URI de redirección asociado con su credencial de Sandbox. Aparecerá un código de autorización de 6 caracteres al final del URI de redireccionamiento en la barra de direcciones del navegador (y debajo de Paso 2 sección a la izquierda de la página en google oauth playground)
Una vez que tenga un Código de autorización, puede cambiarlo por un token de acceso y el Autenticado iD del usuario que inició sesión, que necesitará para realizar las acciones de API para las que solicitó permiso.
Si pierde el token de acceso, puede completar el proceso nuevamente, pero primero deberá revocar el permiso para la aplicación del cliente si usa el mismo ORCID identificación. El permiso se puede revocar eliminando la aplicación del cliente de la sección "Organizaciones de confianza" en la página "Partes de confianza"
En una situación del mundo real, este intercambio lo realizaría su sistema, utilizando un lenguaje de programación como PHP, Java o Ruby on Rails. Para este tutorial, usaremos Google OAuth Playground para simular una aplicación web.
Haga clic 'Código de autorización de intercambio por tokens'
Una vez que haga clic en "Intercambiar código de autorización por tokens” Tu token de acceso y Autenticado iD aparecerá en el Solicitar respuesta sección de la derecha. Por favor, vea el ejemplo a continuación:
¡Guarda esta ficha!
Es importante guardar el token que recibió en el paso anterior, ya que puede crear fácilmente cualquier llamada que necesite hacer con él. Le recomendamos que almacene la respuesta de intercambio de token completa
Ahora ha recopilado un certificado ID y permiso del usuario para leer su ORCID registrar y actualizar sus ORCID registro.
escribiendo a un ORCID registro (POST)
En esta sección, agregaremos una afiliación educativa a su registro de Sandbox. En el siguiente ejemplo estamos usando el punto final /educación con el XML correcto para agregar la información, pero también puede agregar Empleo o Trabajos, por ejemplo. Vea nuestro Documentación de Github para obtener más archivos de ejemplo y puntos finales y los permisos que necesita para cada uno.
Aquí hay un ejemplo de XML educativo que puede usar para este ejercicio:
<?xml version="1.0" encoding="UTF-8"?>
<education:education
xmlns:common="http://www.orcid.org/ns/common" xmlns:education="http://www.orcid.org/ns/education"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://www.orcid.org/ns/education ../education-3.0.xsd ">
<common:department-name>department-name</common:department-name>
<common:role-title>role-title</common:role-title>
<common:start-date>
<common:year>1948</common:year>
<common:month>02</common:month>
<common:day>02</common:day>
</common:start-date>
<common:end-date>
<common:year>1948</common:year>
<common:month>02</common:month>
<common:day>02</common:day>
</common:end-date>
<common:organization>
<common:name>common:name</common:name>
<common:address>
<common:city>common:city</common:city>
<common:region>common:region</common:region>
<common:country>AF</common:country>
</common:address>
<common:disambiguated-organization>
<common:disambiguated-organization-identifier>http://dx.doi.org/10.13039/100000001</common:disambiguated-organization-identifier>
<common:disambiguation-source>FUNDREF</common:disambiguation-source>
</common:disambiguated-organization>
</common:organization>
<common:url>http://tempuri.org</common:url>
<common:external-ids>
<common:external-id>
<common:external-id-type>grant_number</common:external-id-type>
<common:external-id-value>external-identifier-value</common:external-id-value>
<common:external-id-url>http://tempuri.org</common:external-id-url>
<common:external-id-relationship>self</common:external-id-relationship>
</common:external-id>
<common:external-id>
<common:external-id-type>grant_number</common:external-id-type>
<common:external-id-value>external-identifier-value2</common:external-id-value>
<common:external-id-url>http://tempuri.org/2</common:external-id-url>
<common:external-id-relationship>self</common:external-id-relationship>
</common:external-id>
</common:external-ids>
</education:education>Regrese a la pestaña del navegador para Google Playground. Si no mantuvo la pestaña abierta, puede reiniciar la sesión con la URL que guardó anteriormente (haciendo clic en Aceptar en la advertencia que aparece). O puede configurar la llamada nuevamente completando todos los campos relevantes, asegurándose de que se vean como las capturas de pantalla a continuación:
- Asegúrese de que el configuración tiene su cliente ID y secreto del cliente
- debajo del Paso 2 dentro del área de juegos de google oauth, debe tener su Token de acceso rellenado
Todavía debería tener el token de antes o puede completarlo del ejercicio anterior de esta manera: - Debajo del paso 3, haga clic en Agregar encabezados, ingrese los valores a continuación, luego haga clic en Añada y Cerrar
- Nombre del encabezado: Aceptar
- Valor del encabezado: aplicación/vnd.orcid+ xml
- Debajo del Paso 3: Configure la solicitud a la API, establezca el Método HTTP en POST.
- En primera Solicitar URI campo ingrese:
https://api.sandbox.orcid.org/v3.0/[ORCID ID]/education
Reemplazar [ORCID DNI] con el iD para su registro de Sandbox, formatee XXXX-XXXX-XXXX-XXXX con el que obtuvo permiso para interactuar. - Haga clic Tipo de contenido > Personalizado e ingrese aplicación/vnd.orcid+xml Clic AñadaY, a continuación, haga clic Cerrar.
- Haga clic Ingrese el cuerpo de la solicitud.
Copie el XML de afiliación educativa en la parte superior de esta sección y péguelo en el Cuerpo de solicitud cuadro de texto
OPCIONAL: En primera Cuerpo de solicitud cuadro de texto, edite el XML para reflejar su institución.
Para , utilizar el Registro ROR para encontrar el ROR ID para tu institucionn.
Haga clic Cerrar.
- Haga clic Enviar la solicitud.
Los resultados aparecerán en la Solicitar respuesta sección a la derecha. Desplácese hasta la parte inferior, si ve HTTP / 1.1 201 Creado, ¡su afiliación educativa se agregó con éxito!
¡También guarde su código de colocación que será requerido en la siguiente sección!
Visite la vista pública de su registro de Sandbox en https://sandbox.orcid.org/[ORCID ID] para ver su nueva afiliación educativa.
Tenga en cuenta que Source muestra el nombre del cliente API que agregó la afiliación: este es un elemento clave que ayuda a otros sistemas a consumir ORCID Los datos determinan si esta pieza de información es fidedigna.
Actualizando un ORCID grabar (PONER)
En una situación del mundo real, es posible que deba actualizar la afiliación de un investigador. En esta sección, actualizaremos nuestra afiliación educativa para incluir una fecha de finalización.
Los códigos de venta son códigos numéricos cortos que hacen referencia a un elemento en particular en el ORCID registro. Utiliza el código put con las llamadas a la API para actualizar, eliminar o leer un elemento en particular (a diferencia de un resumen de elementos).
Cada elemento de la ORCID iD se le asigna un código de venta que lo identifica de forma única. Al leer un registro completo o una sección, el código de venta se puede encontrar como un atributo del artículo. Cuándo llamar a un elemento específico en un registro, el código de venta se utiliza para identificar el artículo. Los códigos de venta son únicos dentro del tipo de artículo al que se refieren. Usando este ejemplo, solo un trabajo en el ORCID El registro tendrá el código de venta 733535, aunque 733535 también se puede utilizar como código de venta para un elemento de financiación o una palabra clave.
Cuando publica un elemento en el registro de un investigador, la respuesta de la API contendrá el código de colocación de ese elemento. Puede almacenar el código de colocación para usarlo más tarde si necesita leer, actualizar o eliminar ese elemento.
Para saber el código de venta de un artículo en particular que no tenemos, solo necesitamos leer el registro o un resumen de la sección donde se encuentra ese artículo. El código de colocación del elemento que queremos modificar se devolverá en la respuesta.
En el siguiente ejemplo, estamos actualizando un solo elemento de educación.
Nota: si guardó el código put para su afiliación educativa, puede saltar al paso 4 a continuación. Si no guardó el código de colocación, comience con el paso 1 a continuación.
- Primero tenemos que conseguir un poner código para la afiliación educativa que acaba de agregar, así que abra una nueva ventana de Google Playground y configúrelo siguiendo los primeros 4 pasos de la sección de inicio
- Esta vez, en el campo Solicitar URI, ingrese https://api.sandbox.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/educación . Tenga en cuenta que hemos agregado /educations al final de la URI y que es plural. Esto significa que estamos obteniendo un resumen de todos los elementos de educación en este registro, no solo uno (lo colocaríamos en singular y agregaríamos el /put-code del elemento al final)
- Presiona 'Enviar la solicitud' y deberías ver algo como la imagen a continuación en el Solicitar respuesta sección. Encuentra el poner-código para la afiliación educativa que agregó en la sección anterior (será un número diferente al resaltado aquí).
- Cambiar Método HTTP a PUT
- Haga clic Agregar encabezados y asegúrese de que Aceptar y Tipo de contenido estén configurados en aplicación/vnd.orcid+ xml
- En primera Solicitar URI campo ingrese:
https://api.sandbox.orcid.org/v3.0/[ORCID ID]/education/[PUT CODE]
Reemplazar [ORCID DNI] con el iD para su registro de Sandbox, formato XXXX-XXXX-XXXX-XXXX y [PUT CODE] con el código put para su afiliación educativa - Tome el XML de la sección POST nuevamente y haga clic Ingrese el cuerpo de la solicitud y péguelo.
- Edite la fecha de finalización de su afiliación educativa
- Haga clic Cerrar.
- Haga clic en Enviar la solicitud.
- Los resultados aparecerán en la Solicitar respuesta sección a la derecha. Desplácese hasta la parte inferior, si ve HTTP / 1.1 200 Aceptar, su afiliación educativa se actualizó con éxito. Si ve un mensaje de error, verifique que los valores del encabezado en Agregar encabezados no se han cambiado a texto distorsionado, ej: application%2Fvnd.orcid%2Bxml”
- Visite el vista pública de su registro de Sandbox en https://sandbox.orcid.org/[ORCID ID] para ver su afiliación educativa actualizada con la nueva fecha de finalización completada.
Leyendo un ORCID Grabar (OBTENER)
Regrese a la pestaña del navegador para Google Playground. Si no mantuvo la pestaña abierta, puede reiniciar la sesión con la URL que guardó anteriormente (haciendo clic en Aceptar en la advertencia que aparece). O puede configurar la llamada nuevamente completando todos los campos relevantes, asegurándose de que se vean como las capturas de pantalla a continuación:
- Asegúrese de que el configuración tiene su cliente ID y secreto del cliente
- Paso 2 debe tener su Token de acceso rellenado
Todavía debería tener el token de antes o puede completarlo del ejercicio anterior de esta manera: - Paso 3 Click Agregar encabezados, ingrese los valores a continuación, luego haga clic en Añada y Cerrar
- Nombre del encabezado: Aceptar
- Valor del encabezado: aplicación/vnd.orcid+ xml
- Las configuraciones del paso 3 deberían parecerse a la siguiente captura de pantalla:
- Establezca el método HTTP en .
- En el campo URI de solicitud, ingrese:
https://api.sandbox.orcid.org/v3.0/0000-XXXX-XXXX-XXXX/record
Reemplazar [ORCID DNI] con el iD para su registro Sandbox, formato XXXX-XXXX-XXXX-XXXX
Nota la punto final es la palabra al final del URI. En este caso estamos leyendo un resumen de todo el registro, por lo que terminamos la URL con /record como se muestra arriba. - Haga clic Enviar la solicitud
En el campo Solicitud/Respuesta debería ver un resumen XML de todo el registro. Se parecerá un poco al siguiente ejemplo que muestra la primera parte de la respuesta. Hemos resaltado los códigos de venta como se discutió en la sección anterior
