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 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

¿Cómo obtengo una identificación autenticada?

La integración de 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  utilizando los 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.

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.

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

	"access_token":"43914fb8-7f34-417d-9d4e-eaa820c92c0d",
	"token_type":"bearer",
	"expires_in":631138518,
	"scope":"/read-public",
	"orcid":null

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. 

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

 <?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> 

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

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
•  o enviar un 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.

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