El acceso a la ORCID La API pública requiere un conjunto de credenciales que consisten en un ID de cliente y un secreto de cliente. Esta guía describe los pasos necesarios para obtener ORCID Credenciales de API públicas. ORCID los miembros no necesitan registrarse para la API pública, ya que sus credenciales de miembro se pueden usar en su lugar. Para registrarse para obtener credenciales de miembro, consulte Registrar una aplicación de cliente.
Las credenciales de API públicas están vinculadas a las de un individuo ORCID registro y no puede ser transferido a otra persona. Deberá estar de acuerdo con el Términos de servicio del cliente público antes de que se emitan las credenciales.
Las credenciales de la API de la organización están disponibles para las organizaciones que admiten ORCID a través de una suscripción de membresía paga. Más información sobre
ORCID La membresía/afiliación.
Recomendamos que los desarrolladores prueben la API pública en el servidor de pruebas sandbox antes de usar la versión de producción.
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 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'
Tengas en cuenta de que:
- Sólo URI de HTTPS son aceptados en producción
- Dominios registrados DEBEN 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.
ORCID Admite diferentes cuotas de uso de API y límites de velocidad según la API que estés utilizando.
| API | API anónima | API pública (registrada) | API de miembros |
| Límite de tarifa | 12 solicitudes/seg 40 ráfagas/seg | 12 solicitudes/seg 40 ráfagas/seg | 24 solicitudes/seg 40 ráfagas/seg |
| Cuota de uso | 25k lecturas/día (Por dirección IP) | 100k lecturas/día (por ID de cliente) | Sin cuota de uso |
Solicita un segundo son el número de solicitudes que se pueden realizar por segundo.
Explosiones es la cantidad de solicitudes que permitiremos que se pongan en cola antes de rechazarlas. Las solicitudes en cola se ralentizan a la velocidad de las solicitudes por segundo. Si superas la ráfaga, recibirás una respuesta 503.
Si excede la cuota de uso, se le bloqueará y no podrá realizar más solicitudes dentro del plazo establecido.
Por favor, recuerde que el ORCID La API pública es gratuita para uso no comercial por parte de particulares, tal como se indica en la Condiciones de servicio de las API públicasPor “no comercial” queremos decir que no puede cobrar tarifas de reutilización por la API pública y no puede utilizar la API pública en relación con ningún producto o servicio que genere ingresos.
El uso de la API pública con credenciales de cliente le permitirá a su integración una cuota de uso más alta que la API anónima. Consulte nuestra guía de integración sobre cómo registrar un cliente de API pública.
Si excede regularmente la cuota de uso de API para la API pública, le recomendamos que considere convertirse en un ORCID miembro para tener acceso a nuestra API de miembrosNo solo te permitirá acceder a un límite de velocidad más alto y una cuota de uso sin restricciones, sino que también podrás acceder a datos de terceros de confianza en ORCID registra y aporta datos a ORCID registros de sus sistemas institucionales con el permiso de los usuarios.