Nous faisons de notre mieux pour fournir des messages d'erreur descriptifs dans notre registre et notre API. Voici quelques conseils pour vous aider à résoudre les erreurs que vous pourriez rencontrer.
Erreurs API
Nos codes d'erreur API incluent des messages descriptifs qui doivent être facilement compréhensibles.
Une liste des codes d'erreur API courants, leurs significations possibles et des conseils sur la façon de les résoudre est disponible dans notre documentation technique.
Si vous ne parvenez pas à résoudre le problème que vous rencontrez, veuillez nous en informer.
Erreurs de formatage XML/JSON
Si vous rencontrez des problèmes avec le formatage des données que vous essayez d'ajouter ou de mettre à jour sur un ORCID enregistrement, nous vous recommandons de consulter des exemples en :
- Envoi d'un appel pour lire l'enregistrement ou l'élément individuel pour recevoir un exemple XML/JSON, ou, si vous mettez à jour un enregistrement, le XML/JSON complet pour l'élément que vous mettez à jour, et utilisez-le comme point de départ
- Consulter notre exemples de fichiers XML et JSON dans notre référentiel GitHub - nous avons à la fois du XML/JSON propre pour la publication et du XML/JSON complet pour les exemples de lecture
Avant de pouvoir ajouter un élément au ORCID vous devrez formater vos données dans le ORCID schéma. Formatez vos données dans le ORCID schéma de message en XML ou JSON.
Notre référentiel GitHub contient des ressources qui aideront au formatage lors de la création de nouveaux éléments sur le ORCID enregistrement, et lors de la lecture d'éléments existants sur le ORCID record:
Notez que différentes versions de l'API ont des formats de message différents. Les schémas et exemples des versions 2.0 et 2.1 sont également disponibles.
D'autres exemples peuvent être facilement trouvés en lisant les métadonnées d'un enregistrement bien rempli.
Erreurs de portée
Si vous recevez des erreurs relatives aux champs d'application, nous vous recommandons de :
- Vérifiez que vous n'utilisez pas de portées de membre avec un client API public.
- Si vous ajoutez, mettez à jour ou lisez des données à visibilité limitée, vous disposez des étendues appropriées pour effectuer l'action.
- Vérifiez que vous ne demandez pas d'étendues à 2 branches à l'aide d'OAuth à 3 branches et inversement.
Lorsque vous demandez l'autorisation d'interagir avec un ORCID l'enregistrement de l'utilisateur, vous spécifiez une ou plusieurs « étendues ». Chaque étendue vous permet de faire certaines choses, comme lire l'enregistrement ou mettre à jour une section particulière.
3 patte désigne les trois acteurs impliqués dans l'obtention de l'autorisation d'un utilisateur ; ORCID, votre système et l'utilisateur lui-même.
/authentifier
Ce périmètre est utilisé pour collecter les ORCID iD et lire les informations publiques sur le dossier uniquement. Toutes les autres étendues à 3 branches incluent l'autorisation d'authentification, cette étendue peut donc être omise si vous demandez un autre accès. Cette portée est disponible sur l'API membre ou publique.
/read-limited (API membre uniquement)
Cette étendue est utilisée pour accéder à la lecture des éléments publics et à visibilité limitée sur un ORCID enregistrer. Ce champ d'application n'est disponible que sur l'API Member.
/activities/update (API membre uniquement)
Ce périmètre permet d'écrire, de mettre à jour et de supprimer des éléments dans les sections affiliation, financement, travaux, activités professionnelles, ressources de recherche et évaluation par les pairs d'un ORCID enregistrer. Ce champ d'application n'est disponible que sur l'API Member.
/person/update (API membre uniquement)
Cette portée est utilisée pour écrire, mettre à jour et supprimer des éléments dans les sections autres noms, mots-clés, pays, URL de recherche, sites Web et identifiants externes personnels de l'enregistrement. Ce champ d'application n'est disponible que sur l'API Member.
ouvert
Cette portée est utilisée par les intégrateurs OpenID lorsqu'un id_token est requis. Lorsque la portée openid est incluse, le registre renvoie un id_token dans la réponse du jeton et accorde au client l'autorisation d'accéder au point de terminaison des informations utilisateur pour cet utilisateur. Cette portée est disponible sur l'API publique et membre.
Veuillez noter que la portée 'openid' ne commence pas par un '/' comme les autres ORCID Portées de l'API. Ceci est dû au fait que la portée 'openid' n'est pas définie par ORCID, mais défini à la place par la spécification OpenID Connect. Veuillez consulter notre Documentation OpenID pour plus d'information.
Portées multiples
Plusieurs étendues peuvent être demandées en une seule interaction en répertoriant les étendues dans l'URL d'authentification avec un espace encodé entre chacune, comme scope=/read-limited%20/activities/update%20/person/update
Accès complet
Si vous souhaitez un accès complet pour lire et modifier un enregistrement, incluez trois étendues dans votre URL d'authentification : /read-limited, /activities/update et /person/update. Dans l'URL, ils apparaîtraient sous la forme scope=/read-limited%20/activities/update%20/person/update
Portées à deux branches (informations d'identification client)
Pour certaines activités, vous n'avez pas besoin de demander la permission à l'utilisateur. Les champs d'application OAuth à deux branches sont demandés directement à partir du ORCID API et ne nécessitent pas l'autorisation du chercheur. Les tokens avec ces portées sont valables 20 ans et peuvent être réutilisés
/ read-public
Cette portée est utilisée pour lire des informations publiques sur un seul ORCID ID, rechercher ORCID enregistrements ou pour lire des informations récapitulatives (API membre uniquement). Cette portée est disponible sur l'API membre ou publique.
/ webhook
Cette étendue permet à une application cliente d'enregistrer un webhook sur un ORCID enregistrement, afin de recevoir des notifications lorsqu'un enregistrement est mis à jour. Cette portée est disponible pour premium ORCID membres seulement.
Il existe deux portées de mise à jour différentes - une pour les détails biographiques, l'autre pour les activités.
Domaine | Description | Points de terminaison API |
/personne/mise à jour | Données biographiques - la colonne de gauche du ORCID enregistrer l'interface utilisateur. | /adresse /identifiants-externes /mots clés /Autres noms /URL-chercheur |
/activités/mise à jour | Données sur les activités de recherche - la colonne de droite du ORCID enregistrer l'interface utilisateur. | /distinction /distinction /éducation /éducations /emploi /emplois /financement /financements /poste-invité /postes-invités /adhésion /adhésions /examen par les pairs /revues-par les pairs /qualification /qualifications /recherche-ressource /recherche-ressources /un service /prestations de service /travail /travaux |
Messages d'erreur du registre
Généralement, vos utilisateurs ne rencontreront que quelques erreurs liées à l'API lors de l'autorisation d'une connexion avec votre application :
URI de redirection incorrect
L'URI de redirection ne correspond pas à vos URI de redirection enregistrés.
Ce message d'erreur indique que votre lien d'autorisation spécifie un URI de redirection que vous n'avez pas enregistré dans vos informations d'identification client API. Si vous utilisez l'API publique, vous pouvez résoudre ce problème vous-même dans votre Outils de développement. Si vous utilisez l'API Member, vous devrez demander le ORCID L'équipe d'engagement pour mettre à jour vos informations d'identification.
La page demandée est introuvable. Si vous avez cette page dans vos favoris, veuillez la supprimer. Si vous avez suivi un lien, merci de le signaler.
Cette erreur a tendance à se produire lorsque le lien d'autorisation OAuth est mal formé, par exemple https://orcid.org/signin/oauth/authorize?[….] au lieu de https://orcid.org/oauth/authorize?[…]. Pour résoudre, corrigez simplement le lien.
Message non descriptif
Il y a eu un problème avec le serveur. Si ce problème persiste, veuillez contacter le support.
Cette erreur se produit le plus souvent lorsqu'aucune étendue n'est spécifiée. Vous devez inclure une étendue sur le lien d'autorisation OAuth ; la portée minimale est /authentifier.
Vérifier si ORCID travaille!
C'est très, très rare, mais si vous pensez que l'erreur est un problème avec le ORCID Serveurs sur lesquels vous pouvez vérifier http://status.orcid.org/
Notez que le ORCID Sandbox n'a pas de contrat de niveau de service et peut être indisponible pendant des périodes de 20 minutes lorsque nous publions des mises à jour de code.
Obtenir de l'aide
Nous sommes toujours heureux de vous aider! ORCID les organisations membres peuvent obtenir soutien de ORCID directement.
Tous les intégrateurs sont également encouragés à rejoindre le ORCID Groupe d'utilisateurs de l'API, où vous pouvez communiquer avec d'autres intégrateurs et utilisateurs d'API, ainsi qu'avec le ORCID Équipe.