Tutorial de API: búsqueda de ORCID registro

Este tutorial describe cómo buscar el ORCID Registro usando el ORCID API pública y miembro. Ambos métodos requieren un token de acceso recuperado con sus credenciales de cliente.

El sistema ORCID API admite la búsqueda de un subconjunto de ORCID metadatos utilizando la popular sintaxis de consulta Solr. Tenga en cuenta que solo el ORCID iDis devuelto en los resultados de búsqueda. Información sobre la recuperación de datos de un ORCID iD puede encontrarse en Leer datos de un ORCID grabar.

Es posible que la búsqueda de API no sea adecuada para su uso. Es posible que desee considerar estas alternativas:

• Encontrar un investigador ORCID ¿identificación? No recomendamos la entrada manual de ningún ORCID iDs en sus sistemas o procesos. Le recomendamos que recopile información autenticada. ORCID iDs de sus investigadores.
• ORCID lanza un archivo de datos públicos anuales - una instantánea de todos los datos públicos en el ORCID Registro en ese momento, que también se puede utilizar para realizar búsquedas en grandes datos públicos en el Registro. Prima ORCID Los miembros también pueden obtener acceso al archivo de datos a pedido utilizando el sincronización de datos públicos.
• Para obtener instrucciones específicas sobre cómo encontrar un gran número de investigadores de su institución, consulte nuestro consejos para encontrar ORCID poseedores de registros en su institución

a

¿Por qué debería actualizar ORCID ¿registros?

Puede ayudar a facilitar la vida de sus usuarios conectando información validada a sus ORCID registros. También ayudará a generar confianza en las comunicaciones académicas y, al mantener esos datos actualizados, puede reducir la carga de informes para sus usuarios y mejorar la calidad de los datos.

ORCID para organizaciones de investigación

Además de su uso como identificador persistente para sus investigadores, ORCID puede ayudarlo a controlar cómo se usa el nombre de su institución en los sistemas de investigación. En combinación con otros identificadores persistentes ORCID le permite afirmar con autoridad las afiliaciones de su personal, profesores y estudiantes con su institución. También puedes usar ORCID API para recibir notificaciones en tiempo real sobre actividades de investigación, actualizar formularios automáticamente y seguir las carreras de sus alumnos.

ORCID para Organizaciones Financiadoras

Incrustando ORCID iDs en sus flujos de trabajo de financiamiento, puede conectar de manera confiable a sus beneficiarios y programas de financiamiento, y ahorrar tiempo a todos y reducir los errores causados ​​por la introducción manual de información. Utilizando ORCID en su (s) sistema (s), puede desempeñar su papel en la construcción de una infraestructura de información de investigación confiable al afirmar las conexiones entre las personas y las subvenciones que les otorga.

ORCID para editores

Los investigadores están en el centro de todo lo que hacen los editores académicos y de investigación. La información precisa del autor y el revisor es vital para la indexación, la búsqueda y el descubrimiento, el seguimiento de publicaciones, la atribución del uso de recursos y financiación, y el apoyo a la revisión por pares.

ORCID sirve como un centro de información, lo que permite a sus autores y revisores conectarse de manera confiable a sus contribuciones y compartir información de sus ORCID registro a medida que interactúan con sus sistemas de publicación. La recopilación de iD para todos sus autores y revisores durante el proceso de publicación, ya sea para libros, revistas, conjuntos de datos, composiciones, presentaciones, código o una variedad de otros trabajos, permite que la información se comparta fácilmente, garantiza que los investigadores puedan dar su consentimiento para compartir, ahorra tiempo y molestias a los investigadores, reduce el riesgo de errores y, lo que es más importante, permite que los investigadores obtengan el crédito que merecen por el importante trabajo que están realizando.

¿Encontraste útil esta pregunta frecuente?

1

0

Permalink

a

¿Cómo obtengo una identificación autenticada?

Integración ORCID en su sistema le permite a su organización recopilar datos autenticados ORCID ID y agréguelos a sus propios datos. Al mismo tiempo, el investigador otorga permiso a la organización para leer y escribir hacia y desde su ORCID registro. 

Para que esto funcione, las organizaciones DEBE obtener autenticado ORCID identificaciones usando el ORCID API de OAuth. Esto significa que incluyen un ORCID botón o enlace de marca dentro de su sistema, que al hacer clic, solicita al usuario que inicie sesión en su ORCID registro.

Una vez registrado, se le pedirá al usuario que autorice el acceso al sistema solicitando su ORCID iD

Los usuarios ORCID iD y nombre en el ORCID El registro (según la configuración de visibilidad) se devuelve a la organización como parte de este proceso. El sistema puede entonces solicitar datos adicionales del ORCID API.

El flujo de trabajo descrito anteriormente para recopilar API autenticadas está disponible en ambos ORCIDAPI públicas y miembros de. El primero está disponible para su uso de forma gratuita por parte de servicios no comerciales.

¿Encontraste útil esta pregunta frecuente?

5

0

Permalink

Obtener un token de búsqueda

Cualquiera con credenciales de API puede buscar ORCID Registro. La API miembro requiere un / read-public token de acceso para realizar llamadas a la API. Para obtener un token, llame al ORCID API que utiliza autorización OAuth de dos vías (es decir, una llamada directamente a la API). La llamada es la misma para las credenciales de API públicas y de miembros.

a

¿Cómo obtengo el token de acceso "/ read-public"?

Cualquiera con credenciales de API pública o miembro puede recibir una / read-public token de acceso. Para obtener un token, realiza una llamada al ORCID Punto final del token de API.

Este proceso a menudo se denomina flujo de OAuth de credenciales de cliente u OAuth de 2 pasos.

Un ejemplo de llamada para obtener un token de acceso para leer datos públicos en la caja de arena: reemplace los marcadores de posición con sus credenciales (asegúrese de eliminar los corchetes.

URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  METHOD: POST
  DATA: 
    client_id=[Your public API client ID]
    client_secret=[Your public API secret]
    grant_type=client_credentials
    scope=/read-public

A continuación, se le devolverá un token de acceso similar al siguiente. El token devuelto es de larga duración (no caduca durante aproximadamente 20 años) y se puede usar varias veces para recuperar datos públicos de ORCID Records. 

{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}

Nota:  Todos los tokens con el alcance / authenticate ahora también tienen el alcance / read-public incluido. Si usa solo el alcance / authenticate, puede usar los tokens de acceso almacenados para leer datos públicos sin necesidad de volver a obtener un token de acceso. 

Los integradores que utilizan la API miembro pueden utilizar la / read-public alcance para leer ORCID resúmenes de registros.

¿Encontraste útil esta pregunta frecuente?

4

35

Permalink

Búsquedas básicas basadas en palabras clave

Las búsquedas se pueden realizar en el registro de prueba de sandbox o en el registro de producción en vivo. El extremo de la API de búsqueda acepta GET para solicitudes HTTP. La única entrada requerida es la cadena de consulta que se pasa al motor de búsqueda de Solr. 

a

¿Cómo uso el ORCID API de búsqueda?

El sistema ORCID La API de búsqueda utiliza la sintaxis SOLR. Se admiten todas las sintaxis de consulta disponibles en SOLR 3.6, incluido Lucene con extensiones Solr (Por defecto), DisMax y Dismax extendido.

Necesita un token de acceso "/ read-public" para usarlo. Una vez que haya obtenido su token de búsqueda, cree su URL de búsqueda base:

Tipo de credenciales:	Public API	API de miembros
URL del recurso:	Zona de pruebas: https://pub.sandbox.orcid.org Producción: https://pub.orcid.org	Zona de pruebas: https://api.sandbox.orcid.org Producción: https://api.orcid.org
Versión de API:	v3.0
Punto final de búsqueda	/ search /? = [consulta]

Un ejemplo de llamada para buscar “orcid” con el token en la API pública de sandbox con los resultados devueltos en formato XML es:

Method:  GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid

Los resultados especificarán el número de resultados encontrados (número encontrado) y mostrarán los primeros 1000 resultados de forma predeterminada:

 <?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
  <search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search"  xmlns:common="https://www.orcid.org/ns/common">
  <search:result>
  <common:orcid-identifier>
    <common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
    <common:path>/0000-0001-2345-6789</common:path>
    <common:host>sandbox.orcid.org</common:host>
  </common:orcid-identifier>
  </search:result>
  [...]
  </search:search> 

Un ejemplo de búsqueda básica en la API pública de la zona de pruebas con resultados devueltos en formato json:

Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=newman

La búsqueda devuelve solo el individuo ORCID ID de registros que contienen datos públicos que coinciden con la búsqueda. Para obtener más información sobre el resultado, haga una llamada para leer el ORCID grabar directamente.

Para más información, visite nuestras Tutorial de la API de búsqueda.

¿Encontraste útil esta pregunta frecuente?

1

3

Permalink

Búsqueda ampliada

Además de la búsqueda básica, el punto final de la búsqueda ampliada búsqueda ampliada está disponible. El uso de este punto final devuelve la siguiente información: orcid-id, nombres de pila, apellidos, nombres de crédito, otros nombres, correo electrónico e institución cuando se utiliza la sintaxis de búsqueda estándar. Los resultados se pueden devolver en XML o JSON.

Un ejemplo de búsqueda en la API pública de la zona de pruebas para el término "jones"

URL: https://pub.sandbox.orcid.org/v3.0/expanded-search/?q=spaceman

    <expanded-search:expanded-result>
        <expanded-search:orcid-id>0000-0002-2436-0000</expanded-search:orcid-id>
        <expanded-search:given-names>Dave Theodore</expanded-search:given-names>
        <expanded-search:family-names>Spaceman</expanded-search:family-names>
        <expanded-search:other-name>D Spaceman</expanded-search:other-name>
        <expanded-search:other-name>D T Spaceman</expanded-search:other-name>
        <expanded-search:institution-name>The University of The Moon</expanded-search:institution-name>
        <expanded-search:institution-name>Saturn Institute</expanded-search:institution-name>
    </expanded-search:expanded-result>

Resultados de búsqueda devueltos en formato CSV

Los resultados de la búsqueda también se pueden devolver en formato CSV. Como parte de la llamada, puede especificar las columnas de salida de una lista de campos disponibles a continuación:

•  orcido
•  email
•  nombre de pila
•  apellido
•  nombres y apellidos
•  nombre-crédito
•  otro nombre
•  nombre-afiliación-institución-actual
•  nombre-de-afiliación-de-institución-pasada 

Con sus credenciales, debe especificar que el encabezado sea 'texto / csv '. Como parte de la llamada de búsqueda, también debe agregar los campos que necesita en la salida a la consulta.  

Un ejemplo de llamada para un miembro que busca un ID de ringgold* con el resultado requerido que incluye ORCID, nombre y afiliación. 

Method: GET
  Content-type: text/csv
  Authorization type: Bearer
  Access token: [Stored access token]
  URL:  https://api.orcid.org/v3.0/csv-search/?q=ringgold-org-id:385488&fl=orcid,given-names,family-name,current-institution-affiliation-name,'

También puede completar la búsqueda usando su navegador. La URL se construye de la misma manera, pero no es necesario utilizar ninguna credencial de API. Tenga en cuenta que esto solo se puede completar utilizando la API pública. 

Una nota sobre comillas o marcas de habla.

Cuando busque en el navegador, utilice comillas rectas como estas: "" cuando realice búsquedas y no comillas como estas: “”. El uso de comillas rizadas le dará resultados incorrectos.

A continuación se muestra un ejemplo de llamada usando la API pública buscando por nombre de organización con el ORCID, nombres de pila, apellidos, nombre de afiliación de la institución actual y nombre de afiliación de la institución anterior como el resultado deseado. 

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name

A continuación se muestra otro ejemplo de llamada utilizando la API pública que busca por diferentes variaciones del nombre de la organización.

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:(“University of Plymouth” OR “Plymouth University”)

Dar formato a las consultas de búsqueda

El comportamiento predeterminado es una búsqueda de forma libre y sin restricciones en todos los campos indexados disponibles. Por lo tanto, una búsqueda básica de "newman" mostrará investigadores con el nombre publicado Newman, el nombre de pila Newman o asociado con un trabajo con "newman" en el título, etc. Las búsquedas se pueden devolver en json o xml según lo que se especifique en tipo de contenido.

La API también admite búsquedas booleanas utilizando varias palabras clave, frases exactas y otras funciones de búsqueda booleana. Las palabras clave deben combinarse utilizando corchetes y "Y" u "O" en mayúsculas; las minúsculas "y" y "o" se tratan como parte de la búsqueda.

Un ejemplo de búsqueda booleana en la API pública de la zona de pruebas para registros que coinciden con tres palabras clave (johnson, cardiology y houston):

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+cardiology+AND+houston

Un ejemplo de búsqueda booleana en la API pública de la zona de pruebas para registros que coincidan con la palabra clave "johnson" y la palabra clave "caltech" o la frase "Instituto de Tecnología de California" y los resultados devueltos en XML:

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+AND+(caltech+OR+"California+Institute+of+Technology")

Buscar elementos específicos por campo

Puede utilizar una búsqueda por campo cuando necesite buscar una sección específica del ORCID registro.

La sintaxis básica para la búsqueda por campo es campo: valor, por lo que la cadena de consulta family-name: james encontrará registros con el apellido "James", como "Roland James", pero no aquellos con el nombre "James", como como "James Johnson".

Se pueden proporcionar varios pares de campo: valor. La coincidencia se basa en tokens de subcadena en lugar de cadenas sin formato, por lo que la cadena de consulta other-names: carberry coincidirá con J. Carberry y JS Carberry.

a

¿Qué campos ORCID ¿Soporte de API de búsqueda?

El sistema ORCID La API de búsqueda utiliza la sintaxis SOLR. Se admiten todas las sintaxis de consulta disponibles en SOLR 3.6, incluido Lucene con extensiones Solr (Por defecto), DisMax y Dismax extendido.

Puede utilizar una búsqueda por campo cuando necesite buscar una sección específica del ORCID registro. La lista actual de campos reconocidos en la búsqueda de API, junto con sus elementos de estructura de registro correspondientes, son los siguientes:

Campo de búsqueda	Descripción
Datos biograficos
nombres dados	El (los) nombre (s) proporcionado (s) del usuario.
apellido	El (apellido) apellido del usuario.
nombre-crédito	El "nombre publicado" en el ORCID interfaz de usuario, el nombre que normalmente aparece en las publicaciones del usuario
otros nombres	Nombres alternativos que puedan haber aparecido en las publicaciones del usuario.
email	La dirección de correo electrónico del usuario.
keyword	Cualquier palabra clave asociada con el usuario.
referencia-id-externa	Identificadores de otros sistemas añadidos a los del usuario ORCID grabar utilizando la API.
Datos de afiliaciones
nombre-de-organización-de-afiliación	El nombre de cualquier organización en un elemento de educación o empleo en el registro del usuario.
ID-organización-grid	El sistema  ID DE GRID de cualquier organización en la sección de actividades del registro del usuario. Generalmente, esto se asociará con un elemento de educación o empleo.
Ror-org-id	El sistema ID de ROR de cualquier organización en la sección de actividades del registro del usuario. Generalmente, esto se asociará con un elemento de educación o empleo.
Ringgold-org-id	El sistema Identificación Ringgold* de cualquier organización en la sección de actividades del registro del usuario. Generalmente esto estará asociado con un elemento de educación o empleo.
Datos de financiación
títulos-de-financiación	El título de cualquier artículo de financiación en el registro del usuario.
id de org de fondo	El sistema  ID de registro de Crossref Funder de cualquier organización en la sección de actividades del registro de un usuario. Generalmente esto estará asociado con un elemento de financiamiento, pero también puede estar asociado con una afiliación.
números de subvención	Número de concesión (identificador) de cualquier elemento de financiación en el registro del usuario.
Datos de actividades de investigación
títulos de trabajo	Los títulos de cualquier trabajo en el registro del usuario.
identificadores-de-objetos-digitales	Un identificador externo de trabajo con tipo doi
hacer-yo	Un identificador externo de trabajo con tipo doi y la relación de identificador externo establecida en self
[tipo de identificador externo] *	Un identificador externo de trabajo con el tipo dado
[tipo de identificador externo] * - propio	Un identificador externo de trabajo con el tipo dado y la relación de identificador externo establecida en self
[tipo de identificador externo] * - parte de	Un identificador externo de trabajo con el tipo dado y la relación de identificador externo establecida en parte de
[tipo de identificador externo] * - versión de	Un identificador externo de trabajo con el tipo dado y la relación del identificador externo establecida en versión de * Para obtener una lista completa de identificadores externos, consulte la lista de identificadores. Algunos identificadores pueden requerir "-self", "-part-of" o "-version-of" para devolver resultados.
ORCID registrar datos
orcido	El de 16 dígitos ORCID Identificador del usuario, en formato 0000-0001-2345-6789.
fecha de envío de perfil	La fecha y hora en que se creó el registro.
fecha-última-modificación-del-perfil	La fecha y hora en que se modificó por última vez el registro.
Toda la información
texto	Todos los campos anteriores. Este también es el campo predeterminado para las consultas de sintaxis de Lucene.

Vea las reseñas de nuestros Tutorial de la API de búsqueda para obtener más información.

*Aunque los identificadores Ringgold todavía existen dentro del ORCID registro, a partir del 1 de agosto de 2023, ORCID ya no recibe actualizaciones de la base de datos de identificadores de organizaciones RINGGOLD utilizada por nuestro Registro, ni podremos procesar ni utilizar los ID de RINGGOLD creados después de esa fecha. Vea nuestro Preguntas Frecuentes para más información

¿Encontraste útil esta pregunta frecuente?

1

1

Permalink

Paginación de resultados de búsqueda

La API devuelve 1000 resultados (o filas) de forma predeterminada tanto en la API pública como en la miembro. Para mostrar un cierto número de a la vez, o para recuperar más allá de los primeros 1000 resultados, agregue parámetros para el punto de partida y el número de resultados. El número máximo de resultados que se pueden devolver a la vez también es 1000.

Un ejemplo de búsqueda en la API pública de sandbox para los segundos 1000 resultados que coinciden con la palabra clave "orcid":

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=orcid&start=1000&rows=1000

Un ejemplo de búsqueda en la API pública de la zona de pruebas para los elementos 2 a 4 en una búsqueda con los términos "johnson", "cardiología" y "houston":

URL:  https://pub.sandbox.orcid.org/v3.0/search/?q=johnson+cardiology+houston&start=2&rows=3

Consultas de ejemplo usando la API pública

Ejemplo

Buscar apellidos de todos ORCID registros para el nombre "Sánchez"

Ejemplo

Buscar todos los campos de búsqueda de todos ORCID registros de la palabra "inglés"

Ejemplo

Busque colaboradores asociados con el trabajo en PubMed ID 2485-7732

Ejemplo

Busque registros con el apellido "Einstein" y la palabra clave "Relatividad". Solo se devolverán los registros que contengan tanto el apellido como la palabra clave.

Ejemplo

Busque registros con el apellido Taylor y el nombre de pila Michael.

Ejemplo

Buscar nombres y apellidos de todos ORCID graba para “Raymond” pero potencian el apellido. Se devolverán los registros con nombres de pila que contengan “Raymond” y apellido que contenga “Raymond”, pero aquellos con apellido aparecerán en la parte superior de la lista y tendrán una puntuación de relevancia más alta.

Ejemplo

Buscar nombres y apellidos de todos ORCID graba para “Raymond” pero potencian el apellido. Se devolverán los registros con nombres de pila que contengan "Raymond" y apellidos que contengan "Raymond", pero aquellos con apellido aparecerán en la parte superior de la lista y tendrán una puntuación de relevancia más alta. ORCID Los ID https://sandbox.orcid.org/0000-0002-0879-455X y https://sandbox.orcid.org/0000-0001-6238-4490 se excluirán de los resultados.

Ejemplo

Busque registros con el DOI 10.1087 / 20120404 exacto establecido en uno mismo

Ejemplo

Busque registros con un DOI que incluya 10.1087 configurado como propio o como parte de

Ejemplo

Buscar registros con un identificador de PubMed 27281629 configurado como propio

Ejemplo

Busque registros con un identificador ISBN que incluya 1234 configurado como propio o como parte de

Ejemplo

Busque todos los registros con una dirección de correo electrónico con un dominio @orcid.org

Ejemplo

Buscar registros modificados entre el 1 de enero de 2017 y hoy

Ejemplo

Busque registros afiliados a la organización con el nombre exacto "Boston University" o "BU"

Ejemplo

Busque registros afiliados al Ringgold ID* 1438 (Universidad de California Berkeley) con formato CSV

Ejemplo

Busque registros afiliados a GRID ID grid.5509.9 (Universidad de Tampere) mediante la búsqueda ampliada

* Aunque los identificadores Ringgold todavía existen dentro del ORCID registro, a partir del 1 de agosto de 2023, ORCID ya no recibe actualizaciones de la base de datos de identificadores de organizaciones RINGGOLD utilizada por nuestro Registro, ni podremos procesar ni utilizar los ID de RINGGOLD creados después de esa fecha. Vea nuestro Preguntas Frecuentes para más información