Hacemos nuestro mejor esfuerzo para proporcionar mensajes de error descriptivos en nuestro Registro y API. A continuación se ofrecen algunos consejos que le ayudarán con cualquier error que pueda encontrar.
Errores de API
Nuestros códigos de error de API incluyen mensajes descriptivos que deberían ser fácilmente comprensibles.
Una lista de códigos de error de API comunes, sus posibles significados y consejos sobre cómo solucionarlos está disponible en nuestro de documentación técnica.
Si no puede resolver el problema que está experimentando, háganoslo saber.
Errores de formato XML / JSON
Si tiene problemas para formatear los datos que está intentando agregar o actualizar en un ORCID registro, recomendamos consultar ejemplos por:
- Enviar una llamada para leer el registro o un elemento individual para recibir XML / JSON de ejemplo o, si está actualizando un registro, el XML / JSON completo para el elemento que está actualizando, y utilícelo como punto de partida.
- Consultando nuestro archivos XML y JSON de muestra en nuestro repositorio de GitHub: tenemos XML / JSON limpio para publicar y XML / JSON completo para ejemplos de lectura
Antes de que pueda agregar un elemento al ORCID registro, necesitará formatear sus datos en el ORCID esquema. Formatee sus datos en el ORCID esquema de mensaje en XML o JSON.
Nuestro repositorio de GitHub contiene recursos que ayudarán con el formato al crear nuevos elementos en el ORCID registro, y al leer elementos existentes en el ORCID grabar:
Tenga en cuenta que las diferentes versiones de la API tienen diferentes formatos de mensajes. Los esquemas y ejemplos de las versiones 2.0 y 2.1 también están disponibles.
Se pueden encontrar fácilmente más ejemplos leyendo los metadatos de un registro bien poblado.
Errores de alcance
Si recibe errores relacionados con los ámbitos, le recomendamos que:
- Compruebe que no está utilizando ámbitos de miembros con un cliente API público.
- Si está agregando, actualizando o leyendo datos de visibilidad limitada, tiene los alcances correctos para realizar la acción.
- Compruebe que no solicita osciloscopios de 2 patas con OAuth de 3 patas y vis-versa.
Al solicitar permiso para interactuar con un ORCID registro del usuario, usted especifica uno o más 'ámbitos'. Cada alcance le permite hacer ciertas cosas, como leer el registro o actualizar una sección en particular.
Ámbitos de 3 patas (código de autorización)
3 patas se refiere a los tres actores involucrados en la obtención del permiso de un usuario; ORCID, su sistema y el propio usuario.
/autenticar
Este alcance se utiliza para recopilar el ORCID iD y leer información pública en el registro solamente. Todos los demás ámbitos de 3 patas incluyen el permiso de autenticación, por lo que este ámbito se puede omitir si se solicita cualquier otro acceso. Este alcance está disponible en la API pública o miembro.
/ read-limited (solo miembro API)
Este alcance se utiliza para obtener acceso para leer elementos públicos y de visibilidad limitada en un ORCID registro. Este alcance solo está disponible en la API de miembros.
/ actividades / actualización (solo API para miembros)
Este alcance se utiliza para escribir, actualizar y eliminar elementos en las secciones de afiliación, financiación, trabajos, actividades profesionales, recursos de investigación y revisión por pares de un ORCID registro. Este alcance solo está disponible en la API de miembros.
/ person / update (solo API para miembros)
Este alcance se utiliza para escribir, actualizar y eliminar elementos en las secciones de otros nombres, palabras clave, países, URL de investigadores, sitios web e identificadores externos personales del registro. Este alcance solo está disponible en la API de miembros.
abierto
Este alcance lo utilizan los integradores de OpenID cuando se requiere un id_token. Cuando se incluye el alcance de openid, el Registro devolverá un id_token dentro de la respuesta del token y otorgará permiso al cliente para acceder al punto final de información del usuario para ese usuario. Este alcance está disponible en la API pública y para miembros.
Tenga en cuenta que el alcance 'openid' no comienza con un '/' como el otro ORCID Ámbitos de API. Esto se debe a que el alcance 'openid' no está definido por ORCID, pero en su lugar está definido por la especificación OpenID Connect. Por favor vea nuestro Documentación de OpenID para obtener más información.
Múltiples alcances
Se pueden solicitar múltiples alcances en una sola interacción enumerando los alcances en la URL de autenticación con un espacio codificado entre cada uno, como alcance = / lectura limitada% 20 / actividades / actualización% 20 / persona / actualización
Acceso completo
Si desea acceso completo para leer y editar un registro, incluya tres ámbitos en su URL de autenticación: / lectura limitada, / actividades / actualización y / persona / actualización. En la URL aparecerían como scope = / read-limited% 20 / activities / update% 20 / person / update
Ámbitos de 2 patas (credencial de cliente)
Para algunas actividades, no es necesario pedir permiso al usuario. Los ámbitos de OAuth de dos patas se solicitan directamente desde el ORCID API y no requieren que el investigador otorgue permiso. Los tokens con estos alcances son válidos durante 20 años y se pueden reutilizar
/ read-public
Este alcance se utiliza para leer información pública en un solo ORCID identificación, buscar ORCID registros o para leer información resumida (solo API para miembros). Este alcance está disponible en la API pública o para miembros.
/ webhook
Este alcance permite que una aplicación cliente registre un webhook en un ORCID registro, para recibir notificaciones cuando se actualiza un registro. Este alcance está disponible para premium ORCID solo miembros.
Hay dos ámbitos de actualización diferentes: uno para los detalles biográficos y el otro para las actividades.
<b></b><b></b> | Descripción | Puntos finales API |
/ persona / actualización | Datos biográficos: la columna izquierda del ORCID registro de la interfaz de usuario. | /habla a / identificadores-externos / palabras clave /otros nombres / urls-investigador |
/ actividades / actualización | Datos de la actividad de investigación: la columna derecha del ORCID registro de la interfaz de usuario. | /distinción / distinciones /educación / educaciones /empleo / empleos /fondos / financiaciones / puesto-invitado / puestos-invitados /afiliación / membresías / revisión por pares /Revisiones hechas por colegas /calificación / calificaciones / recurso-de-investigación / recursos-de-investigación /Servicio /servicios /trabaja /obras |
Mensajes de error de registro
Generalmente, sus usuarios solo encontrarán algunos errores relacionados con la API al autorizar una conexión con su aplicación:
URI de redireccionamiento incorrecto
El URI de redireccionamiento no coincide con los URI de redireccionamiento registrados.
Este mensaje de error es una indicación de que su enlace de autorización especifica un URI de redireccionamiento que no ha registrado en sus credenciales de cliente API. Si está utilizando la API pública, puede solucionarlo usted mismo en su Herramientas para desarrolladores».. Si está utilizando la API de miembros, deberá solicitar la ORCID Equipo de participación para actualizar sus credenciales.
Enlace incorrecto al formulario de autorización de OAuth
No se puede encontrar la página solicitada. Si ha marcado esta página como favorita, elimínela. Si ha seguido un enlace, infórmelo.
Este error tiende a ocurrir cuando el enlace de autorización de OAuth está formado incorrectamente, p. Ej. https://orcid.org/signin/oauth/authorize?[….] en lugar de https://orcid.org/oauth/authorize?[…]. Para resolverlo, simplemente corrija el vínculo.
Mensaje no descriptivo
Ha habido un problema con el servidor. Si este problema persiste, comuníquese con el soporte.
Este error ocurre con mayor frecuencia cuando no se especifica ningún ámbito. Debe incluir un alcance en el enlace de autorización de OAuth; el alcance mínimo es / authenticate.
Comprobar si ORCID ¡está trabajando!
Es muy, muy raro, pero si cree que el error es un problema con el ORCID Servidores en los que puede consultar http://status.orcid.org/
Tenga en cuenta que ORCID Sandbox no tiene un acuerdo de nivel de servicio y puede estar inactivo durante períodos de tiempo de 20 minutos cuando lanzamos actualizaciones de código.
Obtener ayuda
¡Siempre estamos felices de ayudar! ORCID las organizaciones miembros pueden obtener el apoyo de ORCID .
También se anima a todos los integradores a unirse al ORCID Grupo de usuarios de API, donde puede comunicarse con otros integradores y usuarios de API, así como ORCID .