Tutorial de API: leer datos en un registro

Recomendamos que los desarrolladores prueben la API pública en el servidor de pruebas sandbox antes de usar la versión de producción. A continuación se muestran los pasos sobre cómo registrarse para obtener credenciales de API públicas en los entornos Sandbox y Production.

• Accede a tu ORCID grabar:
  Servidor de producción: https://orcid.org/signin
  Servidor de pruebas sandbox: https://sandbox.orcid.org/signin
• Haga clic en su nombre en la esquina superior derecha
• Haga clic en Herramientas para desarrolladores». desde la opción de menú
  Nota:  Para acceder a las Herramientas para desarrolladores, debe verificar su dirección de correo electrónico. Si aún no ha verificado su dirección de correo electrónico, se le pedirá que lo haga antes de poder registrarse para las credenciales de la API pública.
• Lea y acepte el 'ORCID Condiciones de servicio de las API públicas
• Haga clic en "Registrarse para ORCID Botón “Credenciales de API públicas”.

Completar el formulario de detalles de la solicitud

• Una vez que se haya registrado para obtener sus Credenciales de API pública, se le redirigirá a las Herramientas para desarrolladores (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• Debe completar el formulario de detalles de la solicitud presentado para registrar una nueva solicitud.
  • Nombre: El nombre de su aplicación. Esto se mostrará a los usuarios cuando otorguen permiso a su aplicación para obtener su ORCID iD, y se mostrará en su Lista de organizaciones de confianza. Recomendamos utilizar el nombre de su organización o servicio (por ejemplo, el nombre de una revista).
  • URL de la aplicación: El sitio web que el usuario puede visitar para obtener más información sobre su aplicación. Esto también se mostrará en su Lista de organizaciones de confianza.
  • Descripción de la aplicación: Información sobre la aplicación que está desarrollando y cómo utilizará la aplicación del usuario. ORCID identificación. Esto se mostrará a los usuarios en la pantalla de OAuth.

Adició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.

• Ingrese su URI de redireccionamiento en el cuadro provisto
• Si necesita ingresar más de 1 URI de redireccionamiento, haga clic en 'Agregar otro URI de redireccionamiento'

Tengan en cuenta que:

• Solo URI de HTTPS son aceptados en producción
• Dominios registrados DEBE coincidir exactamente con los dominios utilizados, incluidos los subdominios
• Registre todos los URI de redirección completos cuando sea posible. Esta es la opción más segura y la que recomendamos. Para obtener más información sobre los URI de redireccionamiento, consulte nuestro Preguntas frecuentes sobre URI de redirección

Guardando tu aplicación

Una vez que haya completado el formulario de solicitud y agregado sus URI de redireccionamiento, puede guardar su solicitud.

• Haga clic en 'Guardar mi aplicación y generar mi ID de cliente y secreto'

Se le redirigirá a la página de herramientas para desarrolladores, que ahora incluirá sus credenciales de cliente de la API pública.

Actualización de sus credenciales

Hacer un cambio en la información de su solicitud es muy simple.

• Edite la información relevante y luego haga clic en 'Guardar solicitud'

Usa tus credenciales

Ahora que tiene sus credenciales, es hora de comenzar a usar el ORCID API pública!

Tenga en cuenta que podemos transferir sus credenciales a la API de miembro si se convierte en un ORCID miembro en el futuro.

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

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.

Para obtener / acceso de lectura limitado, debe pedir permiso al investigador. Haz esto usando OAuth. Específicamente, "OAuth de 3 patas".

Para obtener más información, consulte nuestro Tutorial de API: leer datos en un ORCID grabar

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 actualización. Funciona así:

• Creas un enlace especial
• Cuando se hace clic, se envía al usuario a ORCID
  • ORCID pide al usuario que inicie sesión
  • ORCID pide al usuario que otorgue permiso a su aplicación
  • ORCID envía al usuario de regreso a su sistema con un código de autorización
• Su sistema intercambia ese código por un token de acceso

La URL de autorización personalizada incluye la información de su cliente, así como los 'ámbitos' que especifican las áreas específicas de su registro a las que desea acceder. Después de iniciar sesión, el usuario autoriza la conexión con su sistema y regresa a su página de destino junto con un código de autorización. Este código se utiliza luego para obtener su ORCID iD junto con un token de acceso válido para los ámbitos solicitados.

Cree el enlace de autorización y obtenga un código de autorización

Crea tu enlace de autorización especificando el ID de cliente de tus credenciales de API y la página de destino asociada (URI de redireccionamiento). Elige qué permisos solicitar configurando el parámetro de alcance.

El siguiente ejemplo solicita permiso para leer datos de acceso limitado en el ORCID servidor de prueba de sandbox. En el mundo real, muestra este enlace en su sitio web o lo incluye en un correo electrónico cuando le pide al usuario que se autentique y autorice. Sin embargo, para fines de prueba, simplemente puede pegarlo en su navegador web. ¡Reemplace los datos entre corchetes con la información de su cliente y asegúrese de eliminar los corchetes!

https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]

Cuando el usuario haya hecho clic en el enlace, haya iniciado sesión en ORCID y se les conceden permisos, se les redirige a su sitio, así:

https://[Your landing page]?code=Q70Y3A

Cambie el código de autorización por un ORCID iD y token de acceso

Debe intercambiar inmediatamente el código de autorización por el ORCID iD y token de acceso. El código de autorización caduca con el uso. La solicitud se ve así y no se puede hacer en un navegador web, debe ser realizado por su servidor.

 URL=https://sandbox.orcid.org/oauth/token
  HEADER: Accept: application/json
  HEADER: Content-Type: application/x-www-form-urlencoded
  METHOD: POST
  DATA: 
    client_id=[Your client ID]
    client_secret=[Your client secret]
    grant_type=authorization_code
    code=Six-digit code
    redirect_uri=[Your landing page]

ORCID luego devolverá el autenticado del investigador ORCID iD y un token de acceso en formato JSON:

{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}

Los tokens de acceso tienen una larga vida de forma predeterminada y caducan 20 años después de su emisión. El token se puede usar varias veces antes de que caduque.

Usa el token de acceso

Los tokens de acceso de 3 patas están vinculados a ORCID registro. Para usarlos, los incluye en las solicitudes de API que realiza para leer o actualizar ese registro.

La visibilidad indica la configuración de privacidad del elemento, según la preferencia de visibilidad establecida por el usuario. Si se incluye una etiqueta de visibilidad cuando se publica información a través de la API, se ignorará. Por el contrario, la información se publicará según la preferencia de visibilidad predeterminada del usuario según lo establecido en las preferencias de su cuenta.

Los elementos públicos pueden ser leídos por cualquier persona a través de la API y se muestran en el registro público del investigador. Los elementos de la parte de confianza solo se devuelven a través de la API a los clientes que tienen acceso de lectura limitada; no están en el registro público del investigador. Los elementos privados solo son visibles para el investigador y la fuente del elemento: los únicos elementos privados devueltos a través de la API son aquellos que se agregaron al registro a través de su integración Más sobre la configuración de visibilidad en el ORCID Registro.

Esta llamada de ejemplo recupera un resumen de la ORCID registro en formato XML utilizando la API miembro en el servidor de espacio aislado. Necesita un token de acceso para realizar solicitudes de API a la API pública o miembro.

Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token: 
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record

La API devolverá un mensaje 200 OK, que indica que la solicitud se recibió correctamente y el resumen completo de la ORCID registro, incluyendo resúmenes de elementos individuales.

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
  <record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
     <funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
  [...] 
  </record:record>

Cada elemento (trabajo, financiación, empleo, etc.) tiene un poner código. Esto se puede utilizar para obtener detalles completos del artículo si es necesario.

El sistema ORCID El registro se divide en secciones individuales para que la lectura del registro sea más rápida y coherente. Primero puede llamar a una sección para recibir su resumen y luego llamar usando el código de colocación de un artículo individual para recibir información sólida sobre ese artículo.

A continuación se muestra una tabla de las secciones de resumen que puede utilizar la API para leer.

Todos los elementos (excepto el texto de la biografía) en un ORCID registro tiene un poner código:

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>   
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>      
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">   [...] 
</record:record>

Este código de transferencia se puede utilizar para realizar una llamada a la API para recuperar los datos completos de un artículo. Los siguientes elementos se pueden consultar utilizando un poner código:

Usando el punto final de la sección y el código de colocación, puede llamar a la API usando su mismo token de acceso para obtener ese elemento específico en su totalidad. Esta llamada de ejemplo recupera el elemento de financiación completo 4413 en formato XML utilizando la API de miembro en el servidor de espacio aislado.

Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413

Llamada de ejemplo: GitHub

La API devolverá un mensaje 200 OK para indicar que el mensaje se recibió correctamente y devolverá el XML completo del elemento de financiación:

<?xml version="1.0"  encoding="UTF-8" standalone="yes"?>
    <funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public"  [...] >
    [...] 
    </funding:funding>

Puede comprobar el fuente de un artículo al leerlo si quieres saber quién lo agregó.

Trabaja en ORCID se agrupan según sus identificadores y la relación de esos identificadores con la obra. Hay cuatro tipos de relaciones:

• Propia: el identificador se refiere únicamente a esa obra y se puede agrupar con otras obras que tengan el mismo identificador
• Parte de: la obra forma parte de este identificador y no se puede agrupar con otras obras
• La versión de: estos identificadores se aplican a versiones alternativas del trabajo y se pueden agrupar con uno mismo y con la versión de los identificadores
• Fundado por: estos identificadores se aplican a la financiación del trabajo. Estos identificadores no se utilizan para agrupar obras.

Nuestra API proporciona soporte para esto en XSD. Cada elemento tiene un atributo de índice de visualización que indica su clasificación dentro de su grupo. El índice de visualización más alto es el elemento preferido seleccionado por el investigador. Los elementos agregados a través de la API que no han sido clasificados por el investigador tienen un índice de visualización de 1 y se utilizan como fuente preferida predeterminada dentro del grupo hasta que el investigador los cambie. El índice de visualización también determina la orden de trabajo al leer el ORCID registrar con la API.

Para obtener más información sobre la agrupación en ORCID registros, consulte nuestro Artículo de apoyo.

El sistema ORCID el registro admite la "negociación de contenido". Esto significa que las máquinas y otros sistemas pueden solicitar ORCID registro de metadatos de personas en diferentes formatos.

Uno de estos formatos es JSON-LD, que utiliza la schema.org vocabulario, específicamente el tipo de persona, que conectamos con obras, organizaciones y otros identificadores. También admitimos XML, JSON, RDF XML y turtle, y hemos implementado el intercambio de recursos de origen cruzado (CORS) para que nuestros datos sean de fácil acceso.

• Ver este entrada de blog para obtener una descripción general de ORCID y schema.org
• Vea las reseñas de nuestros documentación técnica sobre negociación de contenido

Buscando un usuario usando cURL así:

curl -iL https://orcid.org/0000-0000-0000-0000

Devolverá un 200 incluso si el usuario no existe. Para evitar esto, use la negociación de contenido en su llamada de la siguiente manera:

curl -iL -H 'Accept: application/xml' https://orcid.org/0000-0000-0000-0000