FAQ sur l'intégration et l'API

Des éléments (travaux, emploi, financement, évaluation par les pairs, etc.) peuvent être ajoutés à un ORCID enregistrer soit manuellement, soit à l'aide du ORCID API des membres. Si vous êtes un particulier souhaitant mettre à jour votre dossier, consultez notre section d'aide à ce sujet ici. Si vous êtes membre et souhaitez ajouter des éléments à un ORCID enregistrement, vous aurez besoin des éléments suivants :

• La permission des chercheurs
• Informations d'identification de l'API du membre
• Et soit:
  • Un système de fournisseur qui s'intègre au ORCID API des membres
  • Votre propre système qui s'intègre au ORCID API des membres

Pour un guide complet pour les membres utilisant l'API pour accéder aux éléments d'un enregistrement, consultez le lien de notre didacticiel API ci-dessous :

Tutoriel API : Ajouter et mettre à jour des données sur un ORCID record

Pour soutenir la composante sociale, nous proposons une boîte à outils de Ressources de sensibilisation pour vous aider à développer une campagne pour soutenir votre intégration et communiquer à vos chercheurs:

• Ce que ORCID est.
• Pourquoi votre système collecte les identifiants et comment votre système effectuera des tâches, telles que la mise à jour de leurs enregistrements.
• Pourquoi vos chercheurs bénéficieront-ils de la création d'un ORCID iD et connecter leurs identifiants à votre système.
• Comment ORCID profite à la communauté de recherche mondiale au sens large.

Nous construirons continuellement cette «bibliothèque» de ressources sur la base des commentaires de la communauté. Si vous avez une idée de quelque chose que vous aimeriez voir, n'hésitez pas à nous contacter.

Intégration ORCID dans votre système permet à votre organisation de collecter des données authentifiées ORCID identifiants et ajoutez-les à vos propres données. Dans le même temps, le chercheur donne à l'organisation la permission de lire et d'écrire vers et depuis son ORCID record. 

Pour que cela fonctionne, les organisations DOIVENT obtenir authentifié ORCID identifiants en utilisant l' ORCID API OAuth. Cela signifie qu'ils incluent un ORCID bouton ou lien de marque dans leur système, qui, lorsqu'il est cliqué, demande à l'utilisateur de se connecter à son ORCID record.

Une fois connecté, il sera demandé à l'utilisateur d'autoriser l'accès au système en demandant son ORCID iD

Les utilisateurs ORCID iD et nom sur le ORCID L'enregistrement (en fonction des paramètres de visibilité) est renvoyé à l'organisation dans le cadre de ce processus. Le système peut alors demander des données supplémentaires au ORCID API.

Le flux de travail décrit ci-dessus pour la collecte des API authentifiées est disponible dans les deux versions. ORCIDLes API publiques et membres de . Le premier peut être utilisé gratuitement par des services non commerciaux.

Le processus pour obtenir l'autorisation d'ajouter ou de mettre à jour des données sur un utilisateur ORCID record utilise OAuth, comme décrit dans notre FAQ OAuth en 3 étapes. seulement ORCID les membres peuvent utiliser l'API des membres pour demander des autorisations de mise à jour. En termes simples, cela fonctionne comme ceci:

• Votre système local crée un lien spécial
• Lorsqu'il clique dessus, l'utilisateur est envoyé vers ORCID, se connecte et accorde la permission
• ORCID renvoie l'utilisateur à votre système avec un 'code d'autorisation'
• Votre système échange ce code contre un «jeton d'accès»
• Le jeton d'accès vous permet de mettre à jour la fiche de l'utilisateur

ORCID s'efforce de permettre des liens transparents et fiables entre les chercheurs, leurs contributions et leurs affiliations en fournissant un identifiant unique et persistant que les individus peuvent utiliser lorsqu'ils s'engagent dans des activités de recherche, d'érudition et d'innovation. S'assurer que le bon ORCID iD est associé au bon chercheur est une étape cruciale pour renforcer la fiabilité du ORCID ensemble de données et l’écosystème plus large des communications savantes. Pour cette raison, ORCID ne permet pas la collecte ou la saisie manuelle de ORCID ID dans n'importe quel flux de travail où il est possible de collecter ORCID ID directement auprès des détenteurs de records eux-mêmes.

Les chercheurs peuvent partager facilement et en toute sécurité leurs ORCID identifiants avec les systèmes avec lesquels ils interagissent, ce qui prouve qu'ils possèdent leur ORCID identifiant. Ces systèmes peuvent ensuite partager des informations sur les activités des chercheurs avec d'autres systèmes, ce qui crée une chaîne d'assertions validées et fiables sur l'activité des chercheurs. Le résultat final est que la bonne personne est associée aux bonnes activités dans un large éventail de flux de travail d’information scientifique.

Pour plus d'informations, voir: https://info.orcid.org/collecting-and-sharing-orcid-ids/

Vous pouvez contribuer à simplifier la vie de vos utilisateurs en connectant des informations validées à leur ORCID records. Vous contribuerez également à renforcer la confiance dans les communications savantes et, en gardant ces données à jour, vous pourrez réduire le fardeau des rapports pour vos utilisateurs et améliorer la qualité des données.

ORCID pour les organismes de recherche

En plus de son utilisation comme identifiant persistant pour vos chercheurs, ORCID peut vous aider à contrôler la manière dont le nom de votre établissement est utilisé dans les systèmes de recherche. En combinaison avec d'autres identifiants persistants ORCID vous permet d'affirmer avec autorité les affiliations de votre personnel, de votre faculté et de vos étudiants avec votre établissement. Vous pouvez aussi utiliser ORCID Des API pour recevoir des notifications en temps réel sur les activités de recherche, pour mettre à jour automatiquement les formulaires et pour suivre la carrière de vos anciens.

ORCID pour les organismes de financement

En intégrant ORCID iDs dans vos flux de travail de financement, vous pouvez connecter de manière fiable vos bénéficiaires et programmes de financement - et faire gagner du temps à tout le monde et réduire les erreurs causées par la saisie manuelle des informations. Utilisant ORCID dans votre (vos) système (s), vous pouvez jouer votre rôle dans la construction d'une infrastructure d'information de recherche fiable en affirmant les liens entre les individus et les subventions que vous leur attribuez.

ORCID pour les éditeurs

Les chercheurs sont au cœur de tout ce que font les éditeurs universitaires et de recherche. Des informations précises sur les auteurs et les réviseurs sont essentielles pour l'indexation, la recherche et la découverte, le suivi des publications, l'attribution du financement et de l'utilisation des ressources et le soutien de l'évaluation par les pairs.

ORCID sert de centre d'information, permettant à vos auteurs et réviseurs de se connecter de manière fiable à leurs contributions et de partager les informations de leurs ORCID enregistrer lorsqu'ils interagissent avec vos systèmes de publication. La collecte d'identifiants pour tous vos auteurs et réviseurs pendant le processus de publication - que ce soit pour des livres, des revues, des ensembles de données, des compositions, des présentations, du code ou une variété d'autres travaux - permet de partager facilement les informations, garantit que les chercheurs peuvent donner leur consentement pour partager, fait gagner du temps et des tracas aux chercheurs, réduit le risque d'erreurs et, surtout, permet aux chercheurs d'obtenir le crédit qu'ils méritent pour l'important travail qu'ils accomplissent.

Demande des organisations membres ORCID Identifiants API des membres sur le serveur de production (en direct) en remplissant le Formulaire de candidature client API de membre de production. Avant d'émettre des informations d'identification de l'API de membre de production, le ORCID L'équipe d'engagement/responsable du consortium examinera une démonstration de votre intégration dans le ORCID bac à sable. Cela nous donne l'occasion de voir les excellentes intégrations que vous avez créées et d'offrir des améliorations de flux de travail, ainsi que de vérifier que toutes les intégrations répondent à nos meilleures pratiques et à nos exigences minimales de lancement.

Pour fournir une démonstration de votre système, vous devrez configurer une intégration fonctionnelle avec le ORCID bac à sable que le ORCID l'équipe peut prévisualiser. Il existe plusieurs façons de partager votre intégration de sandbox fonctionnelle :

1. Recommandée: Démo en direct: Contactez-nous pour planifier une démonstration en direct. Nous vous fournirons un logiciel de réunion qui vous permettra de partager votre écran pour vous permettre de faire une démonstration de votre intégration. 
2. Site de test: Si votre site de développement est public, envoyez-nous l'URL ainsi que des informations d'identification de test (si nécessaire) pour accéder à votre système et des instructions décrivant comment utiliser les ORCID fonctionnalités. Fournissez une documentation supplémentaire pour vérifier ce que nous ne serions pas en mesure de voir du côté utilisateur, par exemple la version de l'API utilisée, les données stockées par votre système, etc.
3. Screencast ou captures d'écran :Envoyer un enregistrement ou un ensemble de captures d'écran avec des descriptions expliquant et démontrant clairement le fonctionnement de votre intégration à chaque étape, y compris ce qui se passe si un utilisateur refuse l'accès ou déconnecte son identifiant. Assurez-vous de fournir une documentation supplémentaire pour vérifier tout ce que nous ne pourrions pas voir du côté de l'utilisateur, comme la version de l'API utilisée et la manière dont les données sont stockées.

Demande des organisations membres ORCID Identifiants API des membres sur le serveur de production (en direct) en remplissant le Formulaire de candidature client API de membre de production. Si vous utilisez un système de fournisseur qui ne figure pas sur la liste ORCID Fournisseurs de services certifiés, votre intégration devra subir un processus de révision pour garantir que le exigences minimales pour l'intégration et meilleures pratiques sont remplies. 

Vous pouvez contacter votre prestataire de services non certifié et obtenir directement de lui la preuve que les critères minimaux sont respectés. Vous devrez envoyer cette preuve à ORCID Équipe d’engagement ou responsable de votre consortium.

Il existe plusieurs façons de partager ces preuves :

1. Screencast ou captures d'écran: Envoyez un enregistrement ou un ensemble de captures d'écran avec des descriptions expliquant et démontrant clairement le fonctionnement de votre intégration à chaque étape, y compris ce qui se passe si un utilisateur refuse l'accès ou déconnecte son identifiant. Assurez-vous de fournir une documentation supplémentaire pour vérifier tout ce que nous ne pourrions pas voir du côté de l'utilisateur, comme la version de l'API utilisée et la manière dont les données sont stockées.
2. Documentation d'intégration accessible au public: Soumettez un lien accessible au public et à jour qui comprend une description claire du fonctionnement de l'intégration à chaque étape. Comme dans l'option 1, assurez-vous de fournir une documentation supplémentaire pour vérifier tout ce que nous ne pourrions pas voir du côté de l'utilisateur, comme la version de l'API utilisée et la manière dont les données sont stockées.

Les informations d'identification du client public sont accordées à des individus et non à des organisations. Les informations d'identification ne peuvent pas être transférées d'un individu à un autre, mais elles peuvent être converties en informations d'identification de l'API membre si l'accord est reçu de toutes les parties et que l'organisation est un membre actif de ORCID.

Le déplacement de l'ID client vers l'API membre ne modifiera pas l'ID client, uniquement le secret client, et vous conserverez le nombre d'ID connectés avec votre autorisation en lecture seule.

Lors de la conversion du client de l'API publique en client de l'API membre, le Conditions d'utilisation du client public ne s'appliquent plus et sont remplacés par les termes de l'accord d'adhésion. 

Pour le transfert, nous aurions besoin de :

1. Confirmation de l'ID client de l'API publique à convertir.
    
2. Que le contact principal de l'organisation et le détenteur de l'enregistrement de l'ID client actuel de l'API publique acceptent la modification des conditions de service. (Le détenteur de l'enregistrement doit être un employé, un entrepreneur ou un dirigeant de l'organisation membre). Nous conserverons un enregistrement du consentement des deux parties.

3. Une date/heure à laquelle la migration doit avoir lieu. Dans le cadre de cette migration, nous mettrons à jour l'ID client et vous enverrons un nouveau secret client dans un e-mail crypté. Veuillez noter qu'une fois que nous aurons mis à jour le client, votre intégration ne fonctionnera pas tant que vous n'aurez pas mis à jour le secret client. C'est pourquoi nous devons fixer une date et une heure pour que cela soit fait et pour éviter des désagréments aux utilisateurs.

Pour que la conversion soit terminée, vous devrez mettre à jour : 

• L'ancien secret client vers le nouveau secret client. 
• L'hôte d'API de pub.orcid.org à api.orcid.org. 

Avec votre ID client d'API de membre converti, vous pouvez mettre à jour les champs d'application pour ajouter champs d'application de l'API membre. Cela nécessitera l'autorisation des utilisateurs et de nouveaux jetons d'accès seront générés pour inclure les nouvelles étendues/autorisations.

Veuillez noter que nous ne sommes pas en mesure de convertir les informations d'identification des clients de l'API membre en informations d'identification de l'API publique.

Pour soutenir la composante sociale, nous proposons une boîte à outils de Ressources de sensibilisation pour vous aider à développer une campagne pour soutenir votre intégration et communiquer à vos chercheurs:

• Ce que ORCID est.
• Pourquoi votre système collecte les identifiants et comment votre système effectuera des tâches, telles que la mise à jour de leurs enregistrements.
• Pourquoi vos chercheurs bénéficieront-ils de la création d'un ORCID iD et connecter leurs identifiants à votre système.
• Comment ORCID profite à la communauté de recherche mondiale au sens large.

Nous construirons continuellement cette «bibliothèque» de ressources sur la base des commentaires de la communauté. Si vous avez une idée de quelque chose que vous aimeriez voir, n'hésitez pas à nous contacter.

Vous pouvez demander les informations d'identification de l'API du membre du sandbox pour créer et tester votre application. Ces informations d'identification vous permettent d'appeler l'API du membre premium sandbox pour lire, écrire et mettre à jour ORCID records. L'accès à l'environnement de test du bac à sable est librement accessible à tous, même si vous n'êtes pas ORCID organisation membre.

Notes: Si vous utilisez un ORCID système de fournisseur de services certifié qui prend déjà en charge ORCID, vous n'avez pas besoin de vous inscrire pour obtenir les informations d'identification de l'API sandbox, sauf si vous souhaitez essayer le ORCID fonctionnalité d'intégration dans l'environnement Sandbox. 

Le bac à sable vous permet de créer des comptes utilisateurs de test et de développer votre intégration sans avoir à vous soucier d'affecter les données en direct (production) ORCID Enregistrement. Le bac à sable se comporte de la même manière que la production ORCID Registre avec quelques exceptions.

Créer un compte de test

Afin de tester le ORCID API et appels d'API, tels que la lecture et l'ajout d'informations à un ORCID record, vous devrez également créer un test ORCID enregistrer dans le bac à sable. Cela peut être fait via l'interface utilisateur, un peu comme sur la production ORCID Enregistrement. Aller à https://sandbox.orcid.org/register et inscrivez-vous pour un compte.

Adresses e-mail des expéditeurs

Le serveur sandbox envoie uniquement des e-mails à Mailinator (@mailinator.com) afin de ne pas spammer involontairement les serveurs de messagerie. Vous ne recevrez pas d'e-mail de vérification ni de notification de réinitialisation du mot de passe, sauf si vous utilisez une adresse @mailinator.com, et une vérification est nécessaire pour apporter des modifications manuelles aux enregistrements de bac à sable. En savoir plus sur leurs boîtes de réception publiques gratuites ici. Si vous ne souhaitez pas utiliser un Mailinator adresse, veuillez noter votre nom d'utilisateur et votre mot de passe (car vous les utiliserez pour autoriser votre application lors des tests), et contactez-nous pour demander de l'aide pour la vérification.

Mailinator est un service de messagerie qui dispose d'un service public gratuit et d'un service privé payant. Pour tester, vous pouvez utiliser le service public entièrement gratuit. En savoir plus sur leurs niveaux ici.

Mailinator est un service tiers qui n'est ni géré ni maintenu par ORCID. Nous vous recommandons d'examiner le fonctionnement de ce service et ses limites avant d'utiliser ces adresses.

Les intégrations doivent stocker plus que juste ORCID enregistrements. Votre système devra être capable de :

• Accepter et stocker ORCID iDs : votre système devra connaître les iD des ORCID enregistrement pour afficher le iD et pour mettre à jour correctement. Stockez-le avec les informations du chercheur qui sont renvoyées dans la réponse d'échange de jetons. Notre recommandation est de stocker l’URI https complet : https://orcid.org/0000-0001-5727-2427.
• Accepter et stocker persistant jetons d'accès et rafraîchir les jetons: les jetons d'accès peuvent être utilisés pour lire et mettre à jour les enregistrements, ainsi que pour indiquer que le iD a été authentifié. Les jetons d'accès sont valables environ 20 ans ou jusqu'à ce que l'utilisateur les révoque. Nous vous recommandons également de stocker le portée du jeton, expiration du jeton et rafraîchir les jetons. Les jetons d'actualisation peuvent être utilisés pour créer de nouveaux jetons d'accès avec des portées identiques ou limitées si nécessaire. Stockez les données du jeton d'accès avec les informations du chercheur.
• Accepter et stocker mettre des codes  : Chaque élément que vous ajoutez au ORCID Le registre sera renvoyé avec un code put par le ORCID API. Enregistrez ce code de mise à 6 chiffres avec l'élément dans votre système‚ c'est ainsi que vous identifierez quel élément doit être lu, mis à jour ou supprimé.
• Fournissez des messages d'erreur et un contact d'assistance lorsqu'une interaction ne se déroule pas comme prévu.

Nous recommandons aux développeurs de tester l'API publique dans le serveur de test sandbox avant d'utiliser la version de production. Vous trouverez ci-dessous les étapes à suivre pour vous inscrire aux informations d'identification de l'API publique dans les environnements Sandbox et Production.

• Connectez-vous à votre ORCID record:
  Serveur de production: https://orcid.org/signin
  Serveur de test Sandbox: https://sandbox.orcid.org/signin
• Cliquez sur votre nom dans le coin supérieur droit
• Cliquer sur Outils de développement à partir de l'option de menu
  Remarque : Pour accéder aux outils de développement, vous devez vérifier votre adresse e-mail. Si vous n'avez pas encore vérifié votre adresse e-mail, vous serez invité à le faire avant de pouvoir vous inscrire pour les informations d'identification de l'API publique
• Lisez et acceptez le 'ORCID Conditions d'utilisation des API publiques
• Cliquez sur "S'inscrire pour ORCID Bouton « Informations d’identification de l’API publique ».

Remplir le formulaire de détails de la demande

• Une fois que vous vous êtes enregistré pour vos informations d'identification d'API publique, vous serez redirigé vers les outils de développement (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
• Vous devez remplir le formulaire de détails de candidature présenté pour enregistrer une nouvelle candidature.
  • Nom: Le nom de votre application. Cela sera affiché aux utilisateurs lorsqu'ils accorderont à votre application l'autorisation d'obtenir leur ORCID iD, et il sera affiché dans leur Liste des organisations de confiance. Nous vous recommandons d'utiliser le nom de votre organisation ou service (par exemple, un nom de journal).
  • URL de l'application : Le site Web que l'utilisateur peut visiter pour en savoir plus sur votre application. Cela sera également affiché dans leur Liste des organisations de confiance.
  • Description de l'application: Informations sur l'application que vous développez et comment vous utiliserez les utilisateurs ORCID identifiant. Cela sera affiché aux utilisateurs sur l'écran OAuth.

L'ajout de Rediriger les URI

Une fois que l'utilisateur a autorisé votre application, il sera renvoyé à un URI que vous spécifiez. Vous devez fournir ces URI à l'avance, sinon vos utilisateurs d'intégration rencontreront une erreur.

• Entrez votre URI de redirection dans la case prévue
• Si vous devez saisir plus d'un URI de redirection, cliquez sur "Ajouter un autre URI de redirection".

Veuillez noter :

• Seulement URI HTTPS sont acceptés en production
• Domaines enregistrés DOIVENT correspondent exactement aux domaines utilisés, y compris les sous-domaines
• Enregistrez tous les URI de redirection dans la mesure du possible. C'est l'option la plus sûre et ce que nous recommandons. Pour plus d'informations sur les URI de redirection, veuillez consulter notre redirection URI FAQ

Enregistrement de votre candidature

Une fois que vous avez rempli le formulaire de candidature et ajouté vos URI de redirection, vous pouvez enregistrer votre candidature.

• Cliquez sur « Enregistrer ma demande et générer mon identifiant client et mon secret »

Vous serez redirigé vers la page des outils de développement qui inclura désormais vos informations d'identification du client de l'API publique

Mise à jour de vos identifiants

Modifier les informations de votre candidature est très simple.

• Modifiez les informations pertinentes, puis cliquez sur "Enregistrer l'application"

Utilisez vos identifiants

Maintenant que vous avez vos identifiants, il est temps de commencer à utiliser le ORCID API publique!

Veuillez noter que nous pouvons transférer vos informations d'identification à l'API membre si vous devenez un ORCID membre dans le futur.

Il y a un certain nombre d'exigences que nous attendons de toutes les intégrations de membres. le ORCID L'équipe s'assurera que ces exigences ont été respectées dans le cadre du processus d'examen de l'intégration. 

• Utilisez OAuth s'authentifier ORCID ID (ne pas autoriser les utilisateurs à rechercher ou à saisir ORCID ID.)
• Présentez l'écran d'autorisation OAuth selon notre lignes directrices
• Inclure un ORCID bouton ou lien de marque sur votre site pour initier l'authentification de l'iD.
• Utilisez HTTPS pour les URI de redirection de votre site et sur ORCID Appels API
• Acceptez et stockez toutes les données renvoyées dans l'échange de jetons avec les données de l'utilisateur dans votre système
• Utiliser le bon portée et méthodes de demande (par exemple, les appels POST pour ajouter de nouvelles informations et les appels PUT pour mettre à jour les informations existantes)
• Afficher publiquement les authentifiés ORCID identifiants. Les identifiants doivent être affichés à la suite de notre marque et iD afficher les lignes directrices.
• Ne pas demander aux utilisateurs de modifier leurs paramètres de visibilité pour les éléments de leur ORCID record pour utiliser votre intégration.

Vous devrez remplir le formulaire pour enregistrer une demande client. Voici un aperçu rapide des champs demandés:

Nom de l'organisation: Votre ORCID nom de l'organisation membre

Adresse e-mail de contact principal pour les informations d'identification : Nous utiliserons cette adresse e-mail pour vous envoyer les informations d'identification dans un e-mail crypté et pour vous contacter si des questions ou des erreurs surviennent lors de votre intégration.

E-mail secondaire pour le mot de passe: Une adresse e-mail à laquelle nous pouvons envoyer votre mot de passe e-mail crypté.

Nom de votre client : Ce sera votre ORCID nom de l’organisation membre. Si vous avez plus d'une intégration, nous ajouterons l'application au nom.

URL de la page d'accueil de votre candidature : Affiché sous forme de lien sur la liste des organisations de confiance au sein des utilisateurs ORCID la page des parties de confiance. Cela devrait être un lien vers votre organisation ou la page principale de votre application.

Brève description de votre application client: Ce texte sera affiché sur l'écran d'autorisation avec l'icône de point d'interrogation pour les utilisateurs de votre intégration. Une brève description de votre intégration est requise

Rediriger les URI: Une fois que l'utilisateur a autorisé votre application, il sera renvoyé à un URI que vous spécifiez. Vous devez fournir ces URI à l'avance, sinon vos utilisateurs d'intégration rencontreront une erreur. 

• Seuls les URI HTTPS sont acceptés.
• Les domaines enregistrés doivent correspondre exactement aux domaines utilisés, y compris les sous-domaines.   
• Enregistrez tous les URI de redirection dans la mesure du possible. 
• Plus de 5 URI de redirection requis ? Veuillez l'indiquer dans les Notes pour ORCID personnel.

Notes pour ORCID D'USINE: Utilisez ce champ pour laisser ORCID le personnel sait quelque chose de plus sur votre demande ou votre intégration

Assistants de recherche et de lien sont des intégrations qui peuvent être utilisées pour importer des éléments (principalement des œuvres) dans le ORCID Enregistrement. Ils doivent subir des tests entre l'intégrateur et ORCID avant de pouvoir être publiés dans l'environnement de registre de production.

En fonction de vos réponses aux questions ci-dessous, votre intégration peut être un bon candidat pour la recherche et le lien. Veuillez nous contacter pour en discuter plus avant avant de commencer à développer un assistant de recherche et de lien :

• Quel est le public cible de l'assistant ? Par exemple, les auteurs, les évaluateurs ou les candidats à une subvention au niveau national, disciplinaire ou mondial
• Quelle est la taille approximative du public attendu ?
• Desservira-t-il une population actuellement mal desservie par les sorciers existants ? Par exemple, des contributions à la recherche dans une langue ou une discipline spécifique, ou qui sont d'un type nouveau
• Comment vous assurerez-vous que l'assistant offre une bonne expérience utilisateur ?
• Quel support utilisateur fournirez-vous ?
• Y a-t-il - ou y aura-t-il - un ORCID personne de référence dans votre organisation, comme un chef de produit, pour l'assistant ?
• Comment allez-vous vous assurer que ORCID Les identifiants sont authentifiés ?
• Est-ce que vous - ou allez-vous - ingérer et afficher ORCID des identifiants sur votre plateforme ?
• Votre recherche de plate-forme est-elle activée par iDs ?

Veuillez consulter notre Flux de travail de recherche et de lien pour plus de détails.

Demande des organisations membres ORCID Identifiants API des membres sur le serveur de production (en direct) en remplissant le Formulaire de candidature client API de membre de production. Avant d'émettre des informations d'identification de l'API de membre de production, le ORCID L'équipe d'engagement/responsable du consortium examinera une démonstration de votre intégration dans le ORCID bac à sable. Cela nous donne l'occasion de voir les excellentes intégrations que vous avez créées et d'offrir des améliorations de flux de travail, ainsi que de vérifier que toutes les intégrations répondent à nos meilleures pratiques et à nos exigences minimales de lancement.

Pour fournir une démonstration de votre système, vous devrez configurer une intégration fonctionnelle avec le ORCID bac à sable que le ORCID l'équipe peut prévisualiser. Il existe plusieurs façons de partager votre intégration de sandbox fonctionnelle :

1. Recommandée: Démo en direct: Contactez-nous pour planifier une démonstration en direct. Nous vous fournirons un logiciel de réunion qui vous permettra de partager votre écran pour vous permettre de faire une démonstration de votre intégration. 
2. Site de test: Si votre site de développement est public, envoyez-nous l'URL ainsi que des informations d'identification de test (si nécessaire) pour accéder à votre système et des instructions décrivant comment utiliser les ORCID fonctionnalités. Fournissez une documentation supplémentaire pour vérifier ce que nous ne serions pas en mesure de voir du côté utilisateur, par exemple la version de l'API utilisée, les données stockées par votre système, etc.
3. Screencast ou captures d'écran :Envoyer un enregistrement ou un ensemble de captures d'écran avec des descriptions expliquant et démontrant clairement le fonctionnement de votre intégration à chaque étape, y compris ce qui se passe si un utilisateur refuse l'accès ou déconnecte son identifiant. Assurez-vous de fournir une documentation supplémentaire pour vérifier tout ce que nous ne pourrions pas voir du côté de l'utilisateur, comme la version de l'API utilisée et la manière dont les données sont stockées.

Les webhooks permettent aux membres premium de « regarder » ORCID dossiers et être informé de tout changement.

À l'aide de l'API et des informations d'identification du client premium, les membres premium peuvent enregistrer une URL de rappel pour chaque membre authentifié. ORCID iD qu'ils souhaitent suivre. Le ORCID le détenteur de l'enregistrement n'a pas à accorder à l'organisation une autorisation spécifique pour enregistrer l'URL, mais l'échange de données réel est basé sur les niveaux de confidentialité définis par le ORCID iD titulaire. 

Avec ça en place ORCID notifiera cette URL spécifiée en envoyant une demande lorsqu'il y a des changements dans le ORCID record.

Toutes les sections d'affiliation utilisent le même ensemble de métadonnées dans l'API:

• Nom de l'organisation:* Le nom de l'organisation au niveau le plus élevé (par exemple « Boston University » plutôt que « Boston University School of Medicine »).
• Ville de l'organisation: * Ville du siège de l'organisation.
• Région de l'organisation: Région où l'organisation est basée.
• Pays de l'organisation * le pays de l'organisation. Celui-ci doit être rempli avec le code pays ISO 3166 Alpha-2 à deux lettres.
• ID d'organisation (ROR, GRID, Ringgold** ou LEI) :* Identifiant unique de l'organisation et de sa source. Nous recommandons d'utiliser l'identifiant de l'organisation mère au sein de l'affiliation et non de la division ou du département.
• Rôle / Titre: Le poste occupé, ou le diplôme décerné ou à décerner.
• Département: Toute subdivision de l'organisation mère.
• URL: Une URL vers une ressource sur l'affiliation
• Date de début: La date à laquelle la relation entre le chercheur et l'organisation a commencé (peut être spécifiée jusqu'à l'année, le mois et le jour).
• Date de fin: La date à laquelle la relation entre le chercheur et l'organisation a pris fin (peut être spécifiée jusqu'à l'année, le mois et le jour)
• Un identifiant externe persistant décrivant l'affiliation: Un identifiant unique pour l'assertion d'affiliation réelle

* Indique un champ obligatoire.

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

Il y a un certain nombre de sections sous la partie biographie d'un ORCID record:

Aussi connu sous le nom: Il peut s'agir d'un prénom abrégé, de variantes comprenant les initiales d'un ou plusieurs prénoms, d'un ou de plusieurs prénoms, d'un ou de plusieurs noms antérieurs ou alternatifs ou d'un ou plusieurs noms dans un jeu de caractères différent. Chaque nom doit être ajouté comme un seul élément. Il s'agit d'un champ de texte libre jusqu'à 255 caractères.

Sites Internet: Cette section comprend une description (facultatif) et une URL de site Web (obligatoire)

Canton La section Pays d'un ORCID record permet aux chercheurs et aux organisations membres d'ajouter un ou plusieurs pays où ils mènent des recherches, ou qui sont le sujet de leur recherche. Les éléments de la liste des pays proviennent de la norme ISO 3166, la norme internationale pour les codes de pays et de région.

Identifiants externes (Autres identifiants) : Cette section ne peut être ajoutée que par les organisations membres. Veuillez noter que, bien que de nombreuses organisations collectent d'autres identifiants externes pour leurs chercheurs, par exemple les identifiants d'auteur Scopus, seul l'émetteur de ces identifiants peut les affirmer avec autorité. Nous recommandons donc fortement à votre organisation d'ajouter uniquement les identifiants que votre ou vos systèmes ont créés et utilisés pour identifier les chercheurs. Cette section comprend quatre volets (* indique un champ obligatoire) :

• Type d'identifiant*
• Valeur d'identification*
• Relation d'identité*
• URL d'identification

• Titre:* Le titre de l'ouvrage
• Sous-titre: Un sous-titre de l'oeuvre
• Titre traduit : Le titre sous lequel l'œuvre apparaît dans une autre langue, la langue du titre traduit est enregistrée en tant qu'attribut
• Titre du journal : Le nom d'une plus grande collection à laquelle appartient le travail, comme un journal pour les articles de journaux ou un livre pour les chapitres de livre. Même s'il s'agit d'un titre de revue, il peut être utilisé pour d'autres travaux
• Brève description: Une brève description ou un résumé de l'œuvre
• Type de citation : Le format dans lequel la citation est fournie. Ce champ est sélectionné dans une liste contenant les valeurs suivantes : APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
• Valeur de citation :  Le contenu de la citation
• Type de travail:  Le type d'objet de l'œuvre. Ce champ doit être sélectionné dans le types de travail pris en charge
• Date de parution: La date à laquelle l'œuvre a été publiée. Nous vous recommandons d'utiliser la date de publication la plus ancienne
• Type d'identifiant externe :* Le type d'identifiant. Ce champ doit être sélectionné dans le identifiants de travail pris en charge
  • Valeur-id-externe :* L'identifiant lui-même
  • URL-id-externe : Une URL à laquelle l'identifiant se résout
  • Externe-id-relation :* Les identifiants qui s'appliquent uniquement au travail ajouté seraient marqués comme Self. Les identifiants qui s'appliquent à une plus grande collection à laquelle appartient cette œuvre seraient définis sur Part-of. Les identificateurs qui s'appliquent aux versions alternatives de l'œuvre seraient définis sur version-of. Les identificateurs qui s'appliquent au financement des travaux seraient financés par.
• URL de travail :  Une url renvoyant à l'œuvre
• Collaborateurs au travail :  Informations sur les personnes qui ont créé l'œuvre
• Code-langue: Le langage utilisé pour décrire le travail dans les domaines précédents
• Canton Un pays dans lequel l'œuvre a été publiée ou associée d'une autre manière

* Indique un champ obligatoire

Il existe de nombreux types de ressources de recherche, des réactifs à usage unique aux collaborations internationales avec des installations dédiées.  ORCID prend en charge un modèle de haut niveau qui peut être lié à d'autres emplacements pour des détails spécifiques au domaine.  

Il existe quatre types de ressources de haut niveau :

Type de ressource	Définition	Exemples
Infrastructure	Une installation, un bâtiment ou un autre espace physique utilisé pour effectuer des recherches	Source de spallation de neutrons, animalerie, enclave de données, site archéologique, réseau de télescopes. navires, avions, fermes, laboratoires
Collection	Un objet ou un groupe d'objets utilisé à des fins de recherche ; peut être tangible ou numérique	Mission océanique, campagne sur le terrain, ensembles de données ou ressources collaboratives, collection de livres rares ; collection de musée, collection de spécimens biologiques
neuf	Matériel utilisé à des fins de recherche	Microscope, ordinateurs, verrerie, échantillons, matériaux
Service	Services utilisés à des fins de recherche	Analyse protéomique, services informatiques, analyse de données, soutien logistique, services juridiques, révision, conseils d'experts ou de personnel

En plus du type de ressource, un élément de ressource de recherche dans un ORCID enregistrement contient les informations suivantes. * indique les éléments requis

• Titre de la proposition/inscription :* Il s'agit du principal champ d'affichage des ressources de recherche, par exemple "Neutron Beam Award" ou "Beam time and computing resources"
• ID de la proposition/inscription :* Il s'agit de l'identifiant public (DOI, PURL, etc.) de la proposition ou de la demande d'utilisation de la ressource. Idéalement, cet identifiant doit être persistant et aboutir à une page de destination publique contenant des informations sur la proposition ou la demande, telle qu'une base de données de récompenses ou un journal des utilisateurs de ressources. 
• Hôte(s) de la proposition :* Il s'agit de l'organisation qui reçoit et traite les propositions ou les demandes de ressources. L'hôte de la proposition peut être le même que l'hôte de la ressource
• ID de l'organisation hôte de la proposition*  Il s'agit de l'identifiant public (l'un parmi ROR, GRID, Open Funder ID, LEI) de l'organisation qui gère la proposition ou le processus de demande
• Ressources):* (jusqu'à 100)
• Nom de la ressource:* – par exemple, « Source de spallation de neutrons »
• Identifiant(s) de ressource :* – à partir d'une liste extensible de types PID acceptables (par exemple RRID, DOI, URI)
• Type de ressource:* – l'un des 'Infrastructures', 'Collections', 'Equipement' ou 'Services'
• Hôte(s) de ressources :* Il s'agit de l'organisation qui administre ou exploite la ressource, telle qu'un laboratoire national, une agence gouvernementale ou une université de recherche 
• ID de l'organisation hôte de la ressource :* Il s'agit de l'identifiant public (l'un parmi ROR, GRID, Ringgold**, Open Funder ID, LEI) de l'organisation qui héberge la ressource.
• URL de la proposition:  Un lien vers la proposition
• Date de début de la proposition :  La date à laquelle l'accès a commencé
• Date de fin de la proposition :  La date à laquelle l'accès a pris fin ou prendra fin

* Indique un champ obligatoire

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

• Rôle:* Le rôle de l'individu dans le processus d'examen, qui peut être sélectionné parmi : président, éditeur, membre, organisateur, examinateur
• Identifiant du groupe :* L'identifiant de groupe utilisé à des fins d'agrégation — pour les articles de revues, l'identifiant par défaut est l'eISSN, qui est automatiquement renseigné via une intégration avec la base de données ISSN. Veuillez noter que si vous devez attribuer un identifiant autre qu'un ISSN, vous devrez le créer avant.
• Organisation organisatrice* : L'organisation qui a organisé l'examen - un éditeur de revue, un organisateur de conférence, un organisme de financement, un corps professoral, etc.
  • Identifiant de l'organisation : L’identifiant persistant de l’organisation organisatrice. Nous prenons actuellement en charge les identifiants ROR, Ringgold**, GRID, LEI ou Crossref Funder Registry. Attention : ce champ n'est pas obligatoire mais nous vous recommandons de publier ces données si vous les disposez.
• Examiner les données :* Ces données se réfèrent à l'activité d'examen et non à ce qui a été examiné
  • Type : Le type d'activité de revue : revue ou évaluation
  • Date: la date à laquelle l'examen a été terminé. Cela peut être large (2008) ou spécifique (2010-12-10) 
  • Identifiant de l'avis: Un unique, de préférence résoluble identifiant fourni par la source de l'avis lui-même. À moins que l'examen ne soit librement disponible, nous recommandons qu'il ne contienne pas de données identifiables pouvant être retracées jusqu'au sujet de l'examen 
• URL de révision : Un lien vers une représentation de l'examen ou de l'enregistrement d'examen en ligne 
• Informations sur le sujet de l'examen : Quoi que l'examinateur ait examiné
  • Type de sujet : Le type d'élément qui a été examiné, par exemple un article de revue, un document de conférence
    • Cela inclut le liste des types de travail ET la liste des types de subventions (« subvention », « contrat », « prix », « prix-salaire ») ET recherche-« proposition de ressources » ET « non défini » 
  • Nom du sujet: Le nom de l'élément examiné
  • Identifiant externe du sujet : L'identifiant unique du sujet de l'avis, par exemple un article DOI 
  • Nom du conteneur du sujet : Le nom de l'objet dont fait partie le sujet de l'examen, par exemple la conférence pour laquelle l'article a été examiné 
  • URL du sujet : L'URL du sujet examiné 

* Indique un champ obligatoire

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

• Type de financement :* Le type de financement octroyé, Ce champ est sélectionné dans une liste contenant les valeurs suivantes : Attribution, Contrat, Subvention, Salaire-attribution
• Titre du financement :* Le titre de l'élément de financement
• Sous-titre: Un sous-titre à l'élément de financement
• Titre traduit : Le titre sous lequel le financement apparaît dans une autre langue, la langue du titre traduit est enregistrée comme attribut
• Description: Une description ou un bref résumé du projet financé.
• Montant: La valeur de la récompense
• Identifiant de financement unique: * Ajoutez-en autant que votre système le sait, car cela facilite le regroupement ORCID Records.
  • Type d'identifiant de financement : utilisez le numéro de subvention, le DOI, l'URI ou l'identifiant de la proposition
  • Valeur de l'identifiant
  • URL de l'identifiant (facultatif)
  • Relation : soi/fait partie de
    Il s'agit d'indiquer la relation entre l'élément de financement et l'identifiant. Par exemple, si l'élément de financement est pour une phase d'une subvention en plusieurs parties et que l'identifiant est pour la subvention en plusieurs parties, alors la relation serait « partie de » ; si l'identifiant est pour la phase individuelle, alors la relation serait « soi ».
• Agence de financement (organisation) :*  Informations sur l'organisme qui a octroyé le financement
  • Nom de l'agence
  • Adresse (ville et pays)
  • Identifiant de l'organisation : Les identifiants pris en charge sont les identifiants ROR, Fundref et Ringgold**.
• Date de début: La date de début du financement
• Date de fin: La date à laquelle le financement a pris fin
• Informations sur les contributeurs :  Informations sur les personnes qui ont reçu le financement
  • ORCID identifiant: Votre ORCID iD de chaque collaborateur au projet de financement ; cela ne devrait inclure que les authentifiés ORCID identifiants
  • Rôle: La nature de la contribution du chercheur

* Indique un champ obligatoire

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

Toutes les sections d'affiliation utilisent le même ensemble de métadonnées dans l'API:

• Nom de l'organisation:* Le nom de l'organisation au plus haut niveau (par exemple «Boston University», plutôt que «Boston University School of Medicine»).
• Ville de l'organisation: * Ville du siège de l'organisation. 
• Région de l'organisation: Région où l'organisation est basée. 
• Pays de l'organisation * le pays de l'organisation. Celui-ci doit être rempli avec le code pays ISO 3166 Alpha-2 à deux lettres.
• ID d'organisation (ROR, GRID, Ringgold** ou LEI) :* Identifiant unique de l'organisation et de sa source. Nous recommandons d'utiliser l'identifiant de l'organisation mère au sein de l'affiliation et non de la division ou du département.
• Rôle / Titre: Le poste occupé, ou le diplôme décerné ou à décerner.
• Département: Toute subdivision de l'organisation mère.
• URL: Une URL vers une ressource sur l'affiliation
• Date de début: La date à laquelle la relation entre le chercheur et l'organisation a commencé (peut être spécifiée jusqu'à l'année, le mois et le jour).
• Date de fin: La date à laquelle la relation entre le chercheur et l'organisation a pris fin (peut être spécifiée jusqu'à l'année, le mois et le jour)
• Un identifiant externe persistant décrivant l'affiliation: Un identifiant unique pour l'assertion d'affiliation réelle

* Indique un champ obligatoire.

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

Toutes les sections d'affiliation utilisent le même ensemble de métadonnées dans l'API:

• Nom de l'organisation:* Le nom de l'organisation au plus haut niveau (par exemple «Boston University», plutôt que «Boston University School of Medicine»).
• Ville de l'organisation: * Ville du siège de l'organisation. 
• Région de l'organisation: Région où l'organisation est basée. 
• Pays de l'organisation * le pays de l'organisation. Celui-ci doit être rempli avec le code pays ISO 3166 Alpha-2 à deux lettres.
• ID d'organisation (ROR, GRID, RInggold** ou LEI) :* Identifiant unique de l'organisation et de sa source. Nous recommandons d'utiliser l'identifiant de l'organisation mère au sein de l'affiliation et non de la division ou du département.
• Rôle / Titre: Le poste occupé, ou le diplôme décerné ou à décerner.
• Département: Toute subdivision de l'organisation mère.
• URL: Une URL vers une ressource sur l'affiliation
• Date de début: La date à laquelle la relation entre le chercheur et l'organisation a commencé (peut être spécifiée jusqu'à l'année, le mois et le jour).
• Date de fin: La date à laquelle la relation entre le chercheur et l'organisation a pris fin (peut être spécifiée jusqu'à l'année, le mois et le jour)
• Un identifiant externe persistant décrivant l'affiliation: Un identifiant unique pour l'assertion d'affiliation réelle

* Indique un champ obligatoire.

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

Toutes les sections d'affiliation utilisent le même ensemble de métadonnées dans l'API:

• Nom de l'organisation:* Le nom de l'organisation au plus haut niveau (par exemple «Boston University», plutôt que «Boston University School of Medicine»).
• Ville de l'organisation: * Ville du siège de l'organisation. 
• Région de l'organisation: Région où l'organisation est basée. 
• Pays de l'organisation * le pays de l'organisation. Celui-ci doit être rempli avec le code pays ISO 3166 Alpha-2 à deux lettres.
• ID d'organisation (ROR, Ringgold**, GRID ou LEI) :* Identifiant unique de l'organisation et de sa source. Nous recommandons d'utiliser l'identifiant de l'organisation mère au sein de l'affiliation et non de la division ou du département.
• Rôle / Titre: Le poste occupé, ou le diplôme décerné ou à décerner.
• Département: Toute subdivision de l'organisation mère.
• URL: Une URL vers une ressource sur l'affiliation
• Date de début: La date à laquelle la relation entre le chercheur et l'organisation a commencé (peut être spécifiée jusqu'à l'année, le mois et le jour).
• Date de fin: La date à laquelle la relation entre le chercheur et l'organisation a pris fin (peut être spécifiée jusqu'à l'année, le mois et le jour)
• Un identifiant externe persistant décrivant l'affiliation: Un identifiant unique pour l'assertion d'affiliation réelle

* Indique un champ obligatoire.

**Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations.

An ORCID Le dossier peut contenir des informations sur le travail d'un chercheur, ses affiliations, son financement, son évaluation par les pairs, etc.

Articles sur ORCID les enregistrements peuvent être décomposés en affirmations qui relient le ORCID titulaire d'une carte d'identité avec une activité ou une affiliation. Ces affirmations peuvent être ajoutées à un ORCID par le chercheur propriétaire du document ou par des systèmes que le chercheur a autorisé à le faire. Nous appelons l'entité qui a ajouté une assertion à un ORCID enregistrer le source.

Exemples

Conformément à nos principes de transparence et d'ouverture, nous pensons qu'il est important de pouvoir voir la source de l'affirmation - qui ajoute cette information au dossier. Voici comment nous procédons :

1. Lorsqu'un chercheur (ou son délégué personne de confiance) ajoute une assertion à son dossier, ORCID enregistre automatiquement cette personne comme source
2. Lorsqu'un système approuvé par le chercheur ajoute une assertion à un enregistrement, ORCID enregistre automatiquement le propriétaire du système (un ORCID membre) comme source.

Nous affichons le nom de la source dans l'interface utilisateur et le rendons disponible (avec son identifiant unique) dans l'API :

Cependant, les flux de travail d'informations de recherche peuvent être plus compliqués que cela, et la source réelle d'une affirmation peut être involontairement masquée par un système ajoutant un élément au nom d'une personne ou d'un autre système. Pour garantir la transparence, nous devons faire la distinction entre qui a établi le lien entre la personne et l'élément, et qui a ajouté l'élément à l'enregistrement. Comme ci-dessus, celui qui ajoute l'élément au ORCID l'enregistrement est le source; celui qui crée le lien entre le ORCID iD et l'article est le origine de l'affirmation.

Par exemple :

1. Un chercheur importe des données dans son ORCID enregistrement à partir d'un système, tel qu'un assistant de recherche et de lien. Le chercheur fait l'affirmation reliant leurs iD avec l'article, ils sont donc les origine de l'assertion; tandis que le système est l'entité qui ajoute l'assertion à la ORCID enregistrer — le source
2. Un chercheur interagit avec le système A (le affirmation originale), qui utilise les services fournis par le système B pour mettre à jour ORCID enregistrements, faisant du système B le source

Nous encourageons notre communauté à s'engager à prendre des mesures pour préserver et partager les informations sur l'origine de l'assertion, afin que tout le monde puisse bénéficier de voir la source.

Pour plus d'informations, s'il vous plaît voir:

• Parcours d'assurance d'assertion : que sont-ils et pourquoi sont-ils importants ?
• Plans d'activation des assertions multiples dans le ORCID Registre

Fonctionne ORCID sont regroupés en fonction à la fois de leurs identifiants et de la relation entre ces identifiants et l'œuvre. Il existe quatre types de relations :

• Soi: l'identifiant se réfère uniquement à cette œuvre et peut être regroupé avec d'autres œuvres qui ont le même identifiant
• Une partie de: l'œuvre fait partie de cet identifiant et ne peut être regroupée avec d'autres œuvres
• Version d': ces identifiants s'appliquent aux versions alternatives de l'œuvre et peuvent être regroupés avec soi et la version des identifiants
• Financé par: ces identifiants s'appliquent au financement des travaux. Ces identifiants ne sont pas utilisés pour le regroupement d'œuvres.

Notre API prend en charge cela dans le XSD. Chaque élément possède un attribut d'index d'affichage qui indique son rang au sein de son groupe. L'indice d'affichage le plus élevé est l'élément préféré sélectionné par le chercheur. Les éléments ajoutés via l'API qui n'ont pas été classés par le chercheur ont un indice d'affichage de 1 et sont utilisés comme source préférée par défaut au sein du groupe jusqu'à ce qu'ils soient modifiés par le chercheur. L'index d'affichage détermine également le bon de travail lors de la lecture du ORCID enregistrer avec l'API.

Pour plus d'informations sur le regroupement sur ORCID dossiers, veuillez consulter notre article de support.

ORCID permet l'ajout de plusieurs types d'œuvres. Vous trouverez ci-dessous une liste des types de travaux actuellement pris en charge, ce qui est en grande partie conforme à la norme de sortie CASRAI.

Publications

Type de travail	Utilisez
livre	Livres écrits par un seul auteur ou en collaboration basés sur des recherches ou des résultats scientifiques généralement dérivés d'un financement évalué par les pairs.
Chapitre du livre	Textes écrits par un seul auteur ou en collaboration sur la base de recherches ou de découvertes et d'expertises universitaires dans un domaine.
critique de livre	Revue critique d'œuvres de fiction ou de non-fiction mettant en lumière les contributions à un art, un domaine ou une discipline.
Entrée du dictionnaire	Entrées de nouveaux mots, nouvelles significations de mots existants, changements d'orthographe et de césure sur une plus longue période et changements grammaticaux.
dissertation	Traité avançant un point de vue original issu de la recherche : une exigence pour un doctorat. Ceci n'est disponible qu'avec l'API v2.x
thèse Dissertation	Un document qui est généralement basé sur des recherches originales et qui témoigne de la maîtrise du candidat à la fois de son propre sujet et de la méthode scientifique. Ceci n'est disponible qu'avec l'API v3.0+
entrée d'encyclopédie	Entrées écrites dans un ouvrage de référence ou un recueil se concentrant sur un domaine particulier ou sur toutes les branches de la connaissance.
livre-édité	Livres édités par un seul auteur ou en collaboration pour la diffusion de résultats de recherche ou d'études qui résultent généralement d'un financement évalué par les pairs.
article de journal	Articles dans des publications à comité de lecture qui diffusent les résultats de la recherche et de l'érudition originales.
numéro de revue	Publications périodiques visant à favoriser le débat intellectuel et la recherche.
article de magazine	Articles dans des publications thématiques publiés à intervalles fixes.
Manuel	Matériel de cours et de devoirs produit à des fins d'enseignement.
ressource en ligne	Informations accessibles uniquement sur le web via des méthodes techniques traditionnelles
article-lettre	Articles dans des publications destinées aux chercheurs, décideurs, professionnels et grand public qui rendent compte d'un projet de recherche ou des activités d'une chaire de recherche ou d'un centre de recherche.
article de journal	Articles dans une publication quotidienne, hebdomadaire ou mensuelle portant sur l'actualité et les questions sociales destinées au public.
pré-impression	Version d'un article rendue publique avant l'examen formel par les pairs et la publication. Ceci n'est disponible qu'avec l'API v3.0+
(ici)	Rapports diffusant les résultats et les livrables d'un contrat de recherche.
évaluation	Une évaluation formelle du travail d'un autre. Ceci n'est disponible qu'avec l'API v3.0+
outil de recherche	Série d'observations, de mesures ou de faits identifiés à partir de la recherche.
publication-étudiante-supervisée	Articles sur des résultats de recherche publiés conjointement avec ou encadrés par le directeur de thèse.
tester	Des évaluations qui comprennent des tests conçus pour la sélection universitaire générale, la sélection dans des cours spécifiques ou à d'autres fins d'évaluation.
traductions	Traductions de livres et d'articles qui identifient les modifications apportées à l'édition originale, comme une préface nouvelle ou révisée.
site de NDN Collective	Emplacements autonomes sur le Web où plusieurs types d'informations sur un thème spécifique sont disponibles.
document de travail	Versions préliminaires des articles qui n'ont pas été révisés mais qui peuvent être partagés pour commentaires.

Congrès

Type de travail	Utilisez
conférence-résumé	Textes d'une longueur spécifiée qui énonce la question à discuter dans un document de conférence proposé.
papier de conférence	Articles écrits seuls ou en collaboration, présentés lors d'une conférence universitaire et publiés dans les actes (pas dans des revues savantes).
affiche-conférence	Affiches affichées dans un cadre de conférence et véhiculant les faits saillants de la recherche de manière efficace par des graphiques convaincants.

Propriété intellectuelle

Type de travail	Utilisez
divulgation	Publications qui établissent les inventions comme art antérieur empêchant ainsi d'autres de breveter la même invention ou le même concept.
Licence	Accords signés pour exploiter un élément de propriété intellectuelle tel qu'un processus, un produit, des données ou un logiciel.
brevet	Une forme de protection de la propriété intellectuelle qui définit le droit exclusif par la loi pour les inventeurs et les cessionnaires d'utiliser et d'exploiter leurs inventions, produits ou procédés, pendant une période de temps limitée.
copyright-enregistré	Propriété enregistrée des droits en vertu d'un système de lois visant à promouvoir à la fois la création et l'accès aux œuvres artistiques, littéraires, musicales, dramatiques et autres œuvres créatives.
marque déposée	Marques telles qu'un nom, un mot, une phrase, un logo, un symbole, un dessin, une image d'un produit ou service qui indique la source et donne le droit de contrôler l'utilisation de l'identifiant.

Autre

Type de travail	Utilisez
annotation	Les annotations contiennent des commentaires ou des descriptions sur une autre ressource. Ceci n'est disponible qu'avec l'API v3.0+
performance artistique	Collection de dossiers d'information qui, ensemble, représentent un historique complet et à jour des productions artistiques ou de performances résultant de, ou liées à, les activités de recherche ou d'érudition de la personne.
plan de gestion des données	Une déclaration formelle décrivant comment les données de recherche seront gérées et documentées tout au long d'un projet de recherche et les conditions concernant le dépôt ultérieur des données dans un référentiel de données pour une gestion et une préservation à long terme. Ceci n'est disponible qu'avec l'API v3.0+
base de données	Une série d'observations structurées, de mesures ou de faits identifiés à partir de la recherche qui peuvent être stockés dans un support de base de données.
invention	Des résultats pratiques et originaux issus de la recherche.
conférence-discours	Un exposé informatif lié à la recherche présenté à un public.
objet physique	Spécimen, échantillon ou autre objet physique utilisé à des fins de recherche ; un objet ou une substance tridimensionnelle inanimée. Ceci n'est disponible qu'avec l'API v3.0+
recherche-technique	Méthodes ou compétences pratiques appliquées à des tâches particulières identifiées dans le cadre de la recherche.
software	Un programme utilisé pour faire fonctionner un ordinateur ou un autre appareil technique.
entreprise dérivée	Une entreprise créée par un organisme de recherche pour faire un usage commercial des résultats et des découvertes du projet de recherche.
normes-et-politique	L'élaboration d'une règle ou d'un principe utilisé comme base de jugement.
norme-technique	Normes techniques (industrielles ou autres) issues de projets de recherche dans lesquels de nouveaux protocoles, méthodes ou matériaux peuvent être développés.
autre	Tout autre type de travail.

Veuillez consulter notre liste des identifiants pris en charge pour l'API V3.0. Nous ajoutons occasionnellement de nouveaux types à la demande de ORCID membres qui souhaitent les utiliser lors de l'ajout d'éléments au registre.

ORCID soutient l'utilisation de  Identifiants ROR, Identifiants GRID et Registre des bailleurs de fonds Crossref identifiants pour lever l'ambiguïté des organisations dans ORCID Records. 

Pour plus d'informations, voir Utilisation des identifiants d'organisation

Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations

Nous avons introduit un nouveau champ généré par le système, qui exprime des identifiants externes (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN et ISBN) dans un format normalisé à des fins de correspondance et de regroupement. La normalisation est effectuée sur la base des règles du type d'identifiant et peut inclure la mise en minuscule de tous les caractères alphabétiques ou la transformation d'espaces, de tirets, de points et d'autres caractères pouvant être traités comme équivalents. Il ajoute également des préfixes et des suffixes standard, le cas échéant. Par example, https://doi.org/10.1/123, 10.1/123 et https://dx.doi.org/10.1/123 apparaîtront tous dans ce champ comme https://doi.org/10.1/123. La valeur de l'identifiant existant n'est pas modifiée.

Le champ contributeur en travaux et financement permet aux intégrations membres de lister les chercheurs qui ont collaboré à un travail ou sont partie à un projet financé. Tant pour le financement que pour les travaux, il est possible d'inclure le donateur ORCID iD à côté du rôle. Nous vous suggérons d'ajouter des contributeurs ORCID iD uniquement si vous avez authentifié le ORCID iD, ou avoir collecté le ORCID iD d'une source qui l'a authentifié. Plusieurs rôles peuvent être ajoutés. La séquence des contributeurs est utilisée pour indiquer où dans la liste des contributeurs le nom du collaborateur ou d'un autre contributeur doit apparaître. Les 2 options que nous supportons sont :

• Prénom
• Supplémentaire

Rôles pour les travaux API 2.0

Vous trouverez ci-dessous la liste des rôles de contributeur pris en charge à l'aide de l'API 2.0.

• auteur
• cessionnaire
• éditeur
• chaise-ou-traducteur
• co-chercheur
• co-inventeur
• étudiant diplomé
• autre-inventeur
• chercheur principal
• chercheur-post-doctorant
• le personnel de soutien

Rôles pour les travaux API 3.0

Avec l'API 3.0, vous pouvez ajouter les rôles ci-dessus ainsi que des rôles CRedIT supplémentaires. La taxonomie CRediT se compose de 14 types de contributions aux travaux savants, ainsi que des directives sur la façon dont ces rôles peuvent être attribués. Vous trouverez ci-dessous la liste complète avec la valeur de l'interface utilisateur et la valeur des métadonnées. La valeur des métadonnées est l'URL selon les recommandations de mise en œuvre NISO 'CRediT doit être codé en JATS xml v1.2, décrit via ce lien : https://jats4r.org/credit-taxonomy. Seule l'URL sera acceptée lors de l'ajout de rôles via l'API.

TERME (valeur de l'interface utilisateur)	URL (Valeur API)
Conceptualisation	https://credit.niso.org/contributor-roles/conceptualization/
Conservation des données	https://credit.niso.org/contributor-roles/data-curation/
Analyse formelle	https://credit.niso.org/contributor-roles/formal-analysis/
Acquisition de financement	https://credit.niso.org/contributor-roles/funding-acquisition/
Enquête	https://credit.niso.org/contributor-roles/investigation/
Méthodologie	https://credit.niso.org/contributor-roles/methodology/
Administration du projet	https://credit.niso.org/contributor-roles/project-administration/
Ressources Supplémentaires	https://credit.niso.org/contributor-roles/resources/
Software	https://credit.niso.org/contributor-roles/software/
Supervision	https://credit.niso.org/contributor-roles/supervision/
Validation	https://credit.niso.org/contributor-roles/validation/
Visualisation	https://credit.niso.org/contributor-roles/visualization/
Rédaction – brouillon original	https://credit.niso.org/contributor-roles/writing-original-draft/
Rédaction - révision et édition	https://credit.niso.org/contributor-roles/writing-review-editing/

Exemple de métadonnées de contributeur de travail:

  https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org  Laure L. Haak  first author  

Rôles pour le financement

• conduire
• co-responsable
• supporté par
• autre-contribution

ORCID fournit un champ de citation de texte libre afin que les informations puissent être facilement saisies au format texte par les chercheurs. Cependant, nous encourageons fortement tous les utilisateurs d'API à ajouter des citations dans BibTeX, qui est lisible par machine. Le format vénérable, bien qu'antérieur à Internet, peut être transformé dans le format souhaité par les intégrations et les auteurs. Il est pris en charge par la plupart des gestionnaires de référence et des plateformes de publication

Pour en savoir plus sur BibTeX, voir https://www.bibtex.org.

Tout auteur dont l'éditeur utilise Crossref pour son enregistrement DOI peut bénéficier de l'intégration de la mise à jour automatique de Crossref.

Les éditeurs doivent inclure les authentifiés ORCID Les identifiants de leurs auteurs dans les métadonnées envoyées à Crossref lors de l'enregistrement du DOI.

Crossref demandera alors l'autorisation à l'auteur via une notification à son ORCID boîte de réception pour mettre à jour leur ORCID enregistrer avec cette publication et toute nouvelle publication de tout éditeur.

Pour plus d'informations, veuillez consulter : https://www.crossref.org/community/orcid/

Chaque élément du ORCID iD se voit attribuer un code put qui l'identifie de manière unique. Lors de la lecture d'un enregistrement ou d'une section entière, le code put peut être trouvé en tant qu'attribut de l'élément. Lorsque appeler un élément spécifique d'un enregistrement, le code put est utilisé pour identifier l'article. Les codes de placement sont uniques dans le type d'élément auquel ils se réfèrent. En utilisant cet exemple, un seul travail dans le ORCID Le registre aura le code put 733535, bien que 733535 puisse également être utilisé comme code put pour un élément de financement ou un mot-clé

Au bénéfice de ORCID l'adhésion, les organisations peuvent demander ORCID pour prendre en charge des types PID supplémentaires dans le ORCID Enregistrement. Par exemple, un membre peut demander que nous ajoutions la prise en charge des PID qu'il utilise pour identifier des échantillons ou des ensembles de données dans sa base de données géologique. Cela permet de créer des liens entre les échantillons et les personnes qui les ont collectés. Et, parce que tous les nouveaux types de PID que nous ajoutons doivent être au moins résolubles, et de préférence FAIR, ces liens sont sans ambiguïté, persistants dans le temps et exploitables - au profit du chercheur, de l'organisation membre et de la communauté au sens large.

Ajout de votre PID !

En tant qu'organisme communautaire, nous voulons nous assurer que ORCID prend en charge les PID utilisés par nos membres. Nous maintenons une complète liste des identifiants existants pris en charge dans le Registre et inviter ORCID membres à utiliser ce document pour demander des PID supplémentaires. Nous nous efforçons de répondre à votre demande dans les plus brefs délais.

ORCID a une section distincte dans le ORCID record pour enregistrer des informations sur les qualifications, l'accréditation, les certificats et les badges

Chaque élément de qualification contiendra toujours :

• Le titre de qualification
• L'identifiant de l'organisation du fournisseur (par exemple, l'identifiant ROR)
• La date à laquelle il a été ajouté au ORCID record
• Qui a ajouté la qualification (la source)

Ils peuvent contenir :

• La date de validité, y compris une date de fin si la qualification expire
• L'ID persistant de qualification, identifiant le type de qualification obtenue.
• L'URL de qualification, qui contient une description lisible par l'homme du type de qualification obtenu.
• L'ID persistant de qualification. Il doit renvoyer à une version en ligne du certificat de qualification. Il peut s'agir d'un ID unique existant ou simplement d'un URI.

Toute personne disposant d'informations d'identification API publiques ou membres peut recevoir un / read-public jeton d'accès. Pour obtenir un jeton, vous appelez le ORCID Point de terminaison du jeton API.

Ce processus est souvent appelé flux OAuth des informations d'identification du client ou OAuth en 2 étapes.

Un exemple d'appel pour obtenir un jeton d'accès pour lire les données publiques sur le bac à sable - remplacez les espaces réservés par vos informations d'identification (veillez à supprimer les crochets.

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

Vous recevrez alors un jeton d'accès similaire au suivant. Le jeton renvoyé a une longue durée de vie (n'expirant pas pendant environ 20 ans) et peut être utilisé plusieurs fois pour récupérer des données publiques à partir 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}

Remarque : Tous les jetons avec l'étendue / authenticate ont maintenant également l'étendue / read-public incluse. Si vous utilisez uniquement l'étendue / authenticate, vous pouvez utiliser les jetons d'accès stockés pour lire les données publiques sans avoir à obtenir à nouveau un jeton d'accès. 

Les intégrateurs utilisant l'API membre peuvent utiliser le / read-public portée à lire ORCID enregistrer des résumés.

Pour obtenir un accès /limité en lecture, vous devez demander la permission au chercheur. Pour ce faire, utilisez OAuth. Spécifiquement, "OAuth à 3 étapes" .

Pour plus d'informations, veuillez consulter notre Tutoriel API : Lire des données sur un ORCID record

ORCID Les intégrations utilisent « OAuth à trois étapes » pour authentifier les utilisateurs et demander l'autorisation d'interagir avec leurs enregistrements. Toute intégration peut demander des autorisations de lecture à l'aide de l'API publique. ORCID les membres peuvent utiliser l'API des membres pour demander des autorisations de mise à jour. Cela fonctionne comme ceci :

• Vous créez un lien spécial
• Lorsqu'il clique dessus, l'utilisateur est envoyé vers ORCID
  • ORCID demande à l'utilisateur de se connecter
  • ORCID demande à l'utilisateur d'accorder l'autorisation à votre application
  • ORCID renvoie l'utilisateur à votre système avec un code d'autorisation
• Votre système échange ce code contre un jeton d'accès

L'URL d'autorisation personnalisée comprend les informations de votre client, ainsi que les «portées» qui spécifient les zones spécifiques de leur dossier auxquelles vous souhaitez accéder. Après s'être connecté, l'utilisateur autorise la connexion avec votre système et est renvoyé à votre page d'accueil avec un code d'autorisation. Ce code est ensuite utilisé pour obtenir leur ORCID iD ainsi qu'un jeton d'accès valide pour les étendues demandées.

Créez le lien d'autorisation et obtenez un code d'autorisation

Vous créez votre lien d'autorisation en spécifiant l'ID client de vos informations d'identification API et la page de destination associée (URI de redirection). Vous choisissez les autorisations à demander en définissant le paramètre scope.

L'exemple ci-dessous demande l'autorisation de lire des données à accès limité sur le ORCID serveur de test sandbox. Dans le monde réel, vous affichez ce lien sur votre site Web ou l'incluez dans un e-mail lorsque vous demandez à l'utilisateur de s'authentifier et d'autoriser. Cependant, à des fins de test, vous pouvez simplement le coller dans votre navigateur Web. Remplacez les données entre crochets par les informations de votre client et assurez-vous de supprimer les crochets !

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

Un utilisateur a cliqué sur le lien, connecté à ORCID et accordés des autorisations, ils sont redirigés vers votre site, comme ceci:

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

Échangez le code d'autorisation contre un ORCID iD et jeton d'accès

Vous devez immédiatement échanger le code d'autorisation pour le ORCID iD et jeton d'accès. Le code d'autorisation expire lors de son utilisation. La requête ressemble à ceci et ne peut pas être effectué dans un navigateur Web, il doit être réalisé par votre serveur.

 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 renverra alors le chercheur authentifié ORCID iD et un jeton d'accès au format 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"}

Les jetons d'accès ont une longue durée de vie par défaut et expirent 20 ans après leur émission. Le jeton peut être utilisé plusieurs fois avant son expiration.

Utilisez le jeton d'accès

Les jetons d'accès à 3 pattes sont liés à des ORCID enregistrement. Pour les utiliser, vous les incluez dans les requêtes API que vous faites pour lire ou mettre à jour cet enregistrement.

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.

Portées à 3 branches (code d'autorisation)

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.

Si vous êtes préoccupé par le fait que plusieurs utilisateurs se trouvent sur la même machine et ne se déconnectent pas entre les sessions, vous pouvez les forcer à se ré-authentifier pendant le processus OAuth. Incluez simplement prompt=login dans la requête OAuth. Vous pouvez également définir un max_age en secondes pour forcer les utilisateurs à se ré-authentifier si leur session dépasse une certaine longueur. Voir notre Documentation OpenID Connect pour plus de détails.

Utilisateurs peut changer lui-même sa langue d'affichage à tout moment. Les paramètres de langue suivants sont disponibles :

Langue	Code
(arabe)	ar
čeština (tchèque)	cs
English	en
Español (Spanish)	es
Français	fr
Deutsch (German)	de
Italiano (italien)	it
日本語 (japonais)	ja
한국어 (coréen)	ko
Polski (polonais)	pl
Português (Portugais)	pt
Русский (russe)	ru
Türkçe (turc)	tr
(chinois simplifié)	zh_CN
(chinois traditionnel)	zh_TW

Tout ou partie des paramètres peuvent être utilisés :

Paramètre	Champ	Remarques
prénoms	Prénom	Votre Prénom le champ sera rempli sur le formulaire d'inscription en ligne si une adresse e-mail spécifiée ou ORCID iD ne correspond pas à celui d'un actif ORCID record.
noms de famille	Nom de famille	Votre nom de famille le champ sera rempli sur le formulaire d'inscription en ligne si l'adresse e-mail indiquée ou ORCID iD ne correspond pas à celui d'un actif ORCID record.
email	Email	Votre e-mail/ORCID iD le champ sera rempli sur le formulaire de connexion si l'adresse e-mail spécifiée est trouvée dans notre système et non valide ORCID iD est spécifié. email le champ sera rempli sur le formulaire d'inscription en ligne si l'adresse e-mail spécifiée est trouvée dans notre système et non valide ORCID iD est spécifié. L'adresse e-mail doit être URL encodée, y compris en remplaçant "@" par "%40". Si vous connaissez le nom de l'utilisateur ORCID iD et adresse e-mail, nous vous suggérons uniquement fournir le ORCID iD dans le paramètre orcid.
orcide	ORCID iD	Votre e-mail/ORCID iD le champ sera rempli sur le formulaire de connexion si le spécifié ORCID iD se trouve dans notre système. formulaire d'inscription en ligne s'affichera sinon si le ORCID iD n'est pas trouvé dans notre système. ORCID iD doit être dans le Format à 16 chiffres du iD URI.

Un exemple d'URL avec ces paramètres est

https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYIn&response_type=coden&scope=/authenticaten&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplaygroundn&family_names=Finn&given_names=Huckleberry&email=huckle%40mailinator.com

Si un jeton d'accès actif existe déjà avec les mêmes étendues que celles demandées par votre URL d'autorisation OAuth et que l'utilisateur est connecté à son ORCID enregistrement, ils ne seront pas invités à accorder à nouveau l'autorisation. Au lieu de cela, ils seront directement dirigés vers l'URI de redirection. Si vous souhaitez demander à un utilisateur d'accorder une autorisation à chaque fois qu'il se connecte, utilisez le forcer la méthode de déconnexion

OAuth implicite est une version plus légère d'OAuth conçue pour être utilisée par des systèmes qui n'ont pas ou ne veulent pas utiliser de composants côté serveur. OAuth implicite peut être implémenté entièrement dans le navigateur en utilisant uniquement javascript. Il est disponible pour les membres et les non-membres et fonctionne comme ceci :

• Vous créez un lien spécial
• Lorsqu'il clique dessus, l'utilisateur est envoyé vers ORCID
  • ORCID demande à l'utilisateur de signer i
  • ORCID demande à l'utilisateur d'accorder l'autorisation à votre application
  • ORCID renvoie l'utilisateur à votre système avec son ORCID iD, un jeton d'accès et un jeton d'identification.
• Votre système extrait et stocke les ORCID iD de la réponse.

Pour des raisons de sécurité, lors de l'utilisation d'OAuth implicite, ORCID ne renverra pas de jetons d'accès avec des autorisations de mise à jour.

Flux implicite

Le flux implicite est conçu pour que les clients n'aient pas besoin d'utiliser leur clé secrète pour lancer ORCID connectez-vous. La sécurité est appliquée en limitant les clients à leurs URL de redirection enregistrées. Ce niveau de sécurité inférieur signifie que ORCID prend uniquement en charge les étendues / authenticate et openid lors de l'utilisation du flux implicite. Les jetons sont également de courte durée, avec une durée de vie de 10 minutes. Ce flux est recommandé pour les applications côté client qui n'ont pas accès à un serveur principal, par exemple les applications téléphoniques ou les applications Web javascript d'une seule page.

https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w

Découvrez nos offres de documentation technique pour plus d'information.

Que sont les URI de redirection et comment sont-ils utilisés ?
Les URI de redirection sont utilisés par notre service d'authentification OAuth comme mesure de sécurité.  ORCID n'enverra les utilisateurs authentifiants qu'aux URI enregistrés par le client demandant l'authentification. Cela empêche les services de se faire passer pour les autres.

Gardez à l'esprit que uniquement les URI HTTPS sont acceptés en production. Vous pouvez tester en utilisant des URI HTTP mais vous devrez vous inscrire URI HTTPS lorsque vous demandez des informations d'identification d'API de membre de production.

Comment faire correspondre les URI de redirection ?

• Vous DEVEZ enregistrer les sous-domaines en tant qu'URI distincts. https://anythingelse.thirdparty.com ne fonctionnera pas.  
• L'enregistrement complet de tous les URI de redirection, y compris le chemin, est encouragé, c'est ce que font la plupart des tiers et c'est l'option la plus sûre.
• Si l'application cliente est enregistrée avec un uri de redirection qui n'est que le nom d'hôte, alors n'importe quel uri de redirection sur cet hôte peut être utilisé. Ainsi, par exemple si l'URI de redirection suivante est enregistrée : https://thirdparty.com alors tous les redirect_uris suivants fonctionneront:
  • https://thirdparty.com/oauth/callback1
  • https://thirdparty.com/callback2
  • https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same

Cependant, https://anythingelse.thirdparty.com ne fonctionnera pas.  Vous DOIVENT enregistrer les sous-domaines en tant qu'URI distincts.

Que se passe-t-il si mon URI de redirection est incorrect ?

Utilisateurs envoyés pour s'authentifier sur ORCID avec des URI de redirection incorrects, un message d'erreur similaire à celui-ci s'affichera :

Gestion des URI de redirection pour les membres

Si vous utilisez l'API membre et que vous souhaitez modifier vos URI de redirection, veuillez contacter notre équipe d'engagement

Gestion des URI de redirection pour les clients publics

Si vous utilisez l'API publique, vous devrez suivre les étapes ci-dessous pour mettre à jour votre liste d'URI de redirection associés à votre ORCID ID client de l'API publique. Vous pouvez le faire en suivant les étapes ci-dessous :

• Connectez-vous à votre ORCID record
• Cliquez sur votre nom dans le coin droit
• Sélectionnez les outils de développement
• Cliquez sur le crayon d'édition à côté du nom du client
• Modifiez un URI de redirection existant ou cliquez sur "Ajouter un autre URI de redirection" pour en modifier un existant
• Une fois que vous avez effectué vos modifications, vous devez cliquer sur l'icône de sauvegarde

Uniquement les URI HTTPS sont acceptés en production. Vous pouvez tester à l'aide d'URI http, mais vous devrez enregistrer des URI HTTPS lorsque vous demanderez des identifiants d'API de membre de production.

OpenID Connect 1.0 est une simple couche d'identité au-dessus du protocole OAuth 2.0. Il complète les flux d'authentification OAuth existants et fournit des informations sur les utilisateurs aux clients de manière bien décrite.

OpenID connect est un moyen standardisé de mettre en œuvre OAuth et de partager des informations sur les utilisateurs authentifiés. Il sera désormais possible de configurer les services à utiliser ORCID « prêt à l'emploi » aux côtés d'autres fournisseurs OpenID Connect conformes aux normes. OpenID Connect fournit également des jetons d'identification partageables, qui sont des objets signés qui peuvent prouver qu'un utilisateur s'est authentifié à l'aide ORCID à un moment précis. Ces jetons peuvent être utilisés par les éléments de l'interface utilisateur pour maintenir les sessions utilisateur.

ORCID prend en charge le profil de conformité Basic OpenID Provider, qui est une extension du flux de code d'autorisation OAuth. ORCID prend également en charge le flux de jetons implicite pour les portées «/ authenticate» et «openid».

Cela signifie que ORCID:

• Incorpore des jetons d'identification signés dans les réponses de jetons pour les codes d'autorisation générés avec la portée « openid »
• Prend en charge le flux implicite lors de l'utilisation de "token" ou "token id_token" response_types et de la portée "openid".
• Prend en charge les paramètres «prompt», «nonce» et «max_age» pour les demandes d'autorisation qui incluent la portée «openid».
• Prend en charge la découverte Openid Connect et les points de terminaison userinfo
• Prend en charge le champ «amr» pour les intégrateurs utilisant l'API membre pour les demandes d'autorisation qui incluent la portée «openid». Cela peut être utilisé pour découvrir si un utilisateur s'est authentifié à l'aide de l'authentification à deux facteurs.

Le lancement d'une authentification OpenID Connect fonctionne de la même manière qu'une authentification OAuth classique. Tout ce qui est requis est que le client demande la portée 'openid'. Si vous utilisez la portée / authenticate, remplacez-la par openid, car authenticate et openid ont la même autorisation, seul l'un ou l'autre doit être utilisé. Si vous utilisez d'autres étendues, ajoutez openid à la liste des étendues demandées. 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.

notez 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 par la spécification OpenID Connect.

Découvrez nos offres de documentation technique pour plus d'information.

ORCID permet aux utilisateurs d'activer Authentification à deux facteurs (2FA) sur leur ORCID Compte. 2FA est un contrôle de sécurité secondaire effectué pendant le processus de connexion. Il fournit une confirmation supplémentaire que l'utilisateur est bien la personne qui se connecte à un ORCID Compte. Pour plus d'informations sur la façon dont cela peut être configuré pour les utilisateurs, veuillez consulter notre Article de la BC.

OpenID connect les intégrateurs utilisant l'API membre peuvent vérifier si l'utilisateur s'est connecté à leur ORCID compte avec 2FA activé dans le cadre du processus OAuth. Cela peut permettre aux membres intégrateurs d'accorder à leurs chercheurs l'accès à des systèmes de sécurité plus élevés.

En accord avec notre engagement envers la maîtrise par les chercheurs de leurs ORCID record, le détenteur de l'enregistrement peut choisir de révoquer n'importe quel jeton d'accès à tout moment en le supprimant des autorisations dans le Organisation de confiancen liste sous leur page Parties de confiance.

À partir de 2018, les chercheurs ne peuvent accorder que des jetons d'accès de longue durée qui durent 20 ans, à moins que l'utilisateur ne révoque l'autorisation.

ORCID fournit un simple Widget Javascript qui peut être utilisé pour obtenir authentifié ORCID iD utilisant OAuth avec OpenID Connect.

Veuillez noter que le widget utilise OAuth implicite, il ne collecte donc aucune autorisation d'écriture. Cela signifie qu'il ne convient pas aux intégrations de membres qui souhaitent mettre à jour des enregistrements. Veuillez consulter notre tutoriel pour Ajout et mise à jour des données sur ORCID Records.

Les informations d'identification du client public sont accordées à des individus et non à des organisations. Les informations d'identification ne peuvent pas être transférées d'un individu à un autre, mais elles peuvent être converties en informations d'identification de l'API membre si l'accord est reçu de toutes les parties et que l'organisation est un membre actif de ORCID.

Le déplacement de l'ID client vers l'API membre ne modifiera pas l'ID client, uniquement le secret client, et vous conserverez le nombre d'ID connectés avec votre autorisation en lecture seule.

Lors de la conversion du client de l'API publique en client de l'API membre, le Conditions d'utilisation du client public ne s'appliquent plus et sont remplacés par les termes de l'accord d'adhésion. 

Pour le transfert, nous aurions besoin de :

1. Confirmation de l'ID client de l'API publique à convertir.
    
2. Que le contact principal de l'organisation et le détenteur de l'enregistrement de l'ID client actuel de l'API publique acceptent la modification des conditions de service. (Le détenteur de l'enregistrement doit être un employé, un entrepreneur ou un dirigeant de l'organisation membre). Nous conserverons un enregistrement du consentement des deux parties.

3. Une date/heure à laquelle la migration doit avoir lieu. Dans le cadre de cette migration, nous mettrons à jour l'ID client et vous enverrons un nouveau secret client dans un e-mail crypté. Veuillez noter qu'une fois que nous aurons mis à jour le client, votre intégration ne fonctionnera pas tant que vous n'aurez pas mis à jour le secret client. C'est pourquoi nous devons fixer une date et une heure pour que cela soit fait et pour éviter des désagréments aux utilisateurs.

Pour que la conversion soit terminée, vous devrez mettre à jour : 

• L'ancien secret client vers le nouveau secret client. 
• L'hôte d'API de pub.orcid.org à api.orcid.org. 

Avec votre ID client d'API de membre converti, vous pouvez mettre à jour les champs d'application pour ajouter champs d'application de l'API membre. Cela nécessitera l'autorisation des utilisateurs et de nouveaux jetons d'accès seront générés pour inclure les nouvelles étendues/autorisations.

Veuillez noter que nous ne sommes pas en mesure de convertir les informations d'identification des clients de l'API membre en informations d'identification de l'API publique.

Cet exemple d'appel récupère un résumé de l'intégralité ORCID enregistrement au format XML à l'aide de l'API membre sur le serveur sandbox. Vous avez besoin d'un jeton d'accès pour faire une demande d'API à l'API publique ou membre.

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

L'API renverra un message 200 OK, indiquant que la demande a été reçue avec succès, et le résumé complet de la ORCID enregistrement, y compris les résumés des éléments individuels

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

Chaque élément (travail, financement, emploi, etc.) a un mettre le code. Cela peut être utilisé pour obtenir tous les détails de l'article si nécessaire.

Votre ORCID L'enregistrement est divisé en sections individuelles pour rendre la lecture de l'enregistrement plus rapide et plus cohérente. Vous pouvez d'abord appeler une section pour recevoir son résumé, puis appeler en utilisant le code de vente d'un élément individuel pour recevoir des informations fiables sur cet élément.

Un tableau des sections récapitulatives que vous pouvez lire à l'aide de l'API est présenté ci-dessous.

Endpoint	Description
/enregistrer	Vue récapitulative de l'intégralité ORCID record
/la personne	Section biographique du ORCID enregistrement, y compris via /researcher-urls ci-dessous
/sommaire	Vue récapitulative des éléments validés et auto-affirmés sur le ORCID enregistrement (uniquement disponible avec l'API membre)
/adresse	Les pays ou régions du chercheur
/e-mail	La ou les adresses e-mail associées à l'enregistrement
/identifiants-externes	Identifiants externes liés dans d'autres systèmes
/mots clés	Mots-clés liés au chercheur et à son travail
/Autres noms	Autres noms sous lesquels le chercheur est connu
/détails personnels	Données personnelles : nom du chercheur, nom de crédit (publié) et biographie
/URL-chercheur	Liens vers les pages personnelles ou de profil du chercheur
/Activités	Résumé de la section activités du ORCID record, y compris via /works ci-dessous.
/éducations	Affiliations éducatives
/emplois	Affiliations professionnelles
/financements	Résumé des activités de financement
/revues-par les pairs	Résumé des activités d'examen par les pairs
/travaux	Résumé des travaux de recherche
/recherche-ressources	Résumé des ressources de recherche
/prestations de service	Résumé des services
/qualifications	Résumé de qualifications
/adhésions	Résumé des adhésions
/distinction	Résumé des distinctions
/postes-invités	Résumé des postes invités

Des éléments (travaux, emploi, financement, évaluation par les pairs, etc.) peuvent être ajoutés à un ORCID enregistrer soit manuellement, soit à l'aide du ORCID API des membres. Si vous êtes un particulier souhaitant mettre à jour votre dossier, consultez notre section d'aide à ce sujet ici. Si vous êtes membre et souhaitez ajouter des éléments à un ORCID enregistrement, vous aurez besoin des éléments suivants :

• La permission des chercheurs
• Informations d'identification de l'API du membre
• Et soit:
  • Un système de fournisseur qui s'intègre au ORCID API des membres
  • Votre propre système qui s'intègre au ORCID API des membres

Pour un guide complet pour les membres utilisant l'API pour accéder aux éléments d'un enregistrement, consultez le lien de notre didacticiel API ci-dessous :

Tutoriel API : Ajouter et mettre à jour des données sur un ORCID record

Cet exemple d'appel récupère un résumé de l'intégralité ORCID enregistrement au format XML à l'aide de l'API membre sur le serveur sandbox. Vous avez besoin d'un jeton d'accès pour faire une demande d'API à l'API publique ou membre.

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

L'API renverra un message 200 OK, indiquant que la demande a été reçue avec succès, et le résumé complet de la ORCID dossier, y compris les résumés des éléments individuels.

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

Chaque élément (travail, financement, emploi, etc.) a un mettre le code. Cela peut être utilisé pour obtenir tous les détails de l'article si nécessaire.

Pour soutenir la composante sociale, nous proposons une boîte à outils de Ressources de sensibilisation pour vous aider à développer une campagne pour soutenir votre intégration et communiquer à vos chercheurs:

• Ce que ORCID est.
• Pourquoi votre système collecte les identifiants et comment votre système effectuera des tâches, telles que la mise à jour de leurs enregistrements.
• Pourquoi vos chercheurs bénéficieront-ils de la création d'un ORCID iD et connecter leurs identifiants à votre système.
• Comment ORCID profite à la communauté de recherche mondiale au sens large.

Nous construirons continuellement cette «bibliothèque» de ressources sur la base des commentaires de la communauté. Si vous avez une idée de quelque chose que vous aimeriez voir, n'hésitez pas à nous contacter.

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:

• Exemples de fichiers XML
• Le XSD pour toutes les sections du 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.

Version antérieure du ORCID L'API avait des champs d'application supplémentaires. Ces étendues ont été progressivement supprimées avec l'API 2.0. Nous encourageons toutes les intégrations à n'utiliser que les étendues recommandées. Pour référence, les portées précédentes sont répertoriées ci-dessous avec la portée actuelle qui doit être utilisée à la place

• /orcid-profile/lecture-limitée utiliser à la place /Lire-limité
• /orcid-works/lecture-limitée utiliser à la place /Lire-limité
• /orcid-bio/limite-de-lectured'utiliser à la place /Lire-limité
• /orcid-works/créer utiliser à la place /activités/mise à jour
• /orcid-works/mise à jour utiliser à la place /activités/mise à jour
• /affiliations/créer utiliser à la place /activités/mise à jour
• /affiliations/mise à jour utiliser à la place /activités/mise à jour
• /financer/créer utiliser à la place /activités/mise à jour
• /financement/mise à jour utiliser à la place /activités/mise à jour
• /orcid-bio/mise à jour utiliser à la place /personne/mise à jour
• /orcid-bio/identifiants-externes/créer utiliser à la place /personne/mise à jour

Les jetons d'actualisation sont utilisés pour générer des jetons d'accès supplémentaires. Un jeton d'actualisation est renvoyé avec le jeton d'accès lors de l'échange d'un code d'autorisation dans le cadre du processus OAuth en trois étapes, et il peut être utilisé tant que le jeton d'accès reste actif.

Les nouveaux jetons d'accès peuvent avoir la même expiration et les mêmes étendues que le jeton d'accès d'origine, ou peuvent être spécifiés pour avoir une durée de vie plus courte ainsi qu'un plus petit sous-ensemble d'étendues du jeton d'accès d'origine. De nouveaux jetons d'accès peuvent être générés afin de remplacer le jeton d'origine ou générés pour servir de jeton supplémentaire. Vous pouvez également utiliser des appels de jeton d'actualisation pour expirer complètement les jetons d'accès et d'actualisation d'origine et toutes les autorisations accordées par l'utilisateur. 

Nous vous suggérons d'utiliser des jetons d'actualisation dans les conditions suivantes :

• Remplacement des jetons d'accès qui pourraient avoir été compromis (assurez-vous de révoquer le jeton d'accès d'origine après)
• Donner à un tiers qui fait également partie de votre ORCID intégration accès plus limité et/ou accès pour une durée limitée.

Veuillez consulter notre documentation technique sur la façon de créer de nouveaux jetons d'accès à partir de jetons d'actualisation.

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

Utilisez votre ID client, votre secret et soit le jeton actif, soit son jeton d'actualisation associé pour révoquer la paire de jetons. Vous pouvez révoquer les paires de jetons créées dans les deux processus OAuth en trois étapes.  Si vous avez plusieurs ensembles de jetons, par exemple pour différentes portées, seul le jeton d'accès spécifié et le jeton d'actualisation correspondant seront révoqués.

Nous vous suggérons de révoquer les jetons dans les conditions suivantes :

• Pour révoquer les tokens émis à un fournisseur tiers après la rupture d'une relation ;
• Pour révoquer les jetons lorsque les utilisateurs déconnectent leur ORCID iD de votre système ;
• Pour permettre aux utilisateurs de révoquer les jetons depuis votre système.

Nous recommandons d'utiliser le rafraîchir les jetons pour limiter la portée ou la durée d'un jeton d'accès existant ou mettre à jour un jeton s'il a été compromis.

L'appel d'API de révocation

https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
  METHOD: POST
  HEADER: accept:application/json
  CONTENT-TYPE: application/x-www-form-urlencoded 
  DATA: 
    client_id=[Your client ID]
    client_secret=[Your client secret]
    token=[access token or refresh token for token pair to be revoked]

Tous les éléments (à l'exception du texte de la biographie) sur un ORCID enregistrement ont un mettre le code:

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

Ce code put peut être utilisé pour appeler l'API afin de récupérer les données complètes d'un élément. Les éléments suivants peuvent être interrogés à l'aide d'un mettre le code:

Endpoint	Description
/adresse/[mettre le code]	Un pays ou une région
/Biographie	Le champ biographie : une zone de texte libre que seul le chercheur peut éditer
/éducation/[mettre le code]	Un élément individuel d'affiliation à l'enseignement
/email/[mettre le code]	Une adresse e-mail individuelle associée à l'enregistrement
/emploi/[mettre le code]	Un poste individuel d'affiliation professionnelle
/identifiant-externe/[mettre le code]	Un identifiant externe individuel lié dans un autre système
/financement/[mettre le code]	Une activité de financement individuelle
/mots-clés/[mettre le code]	Un mot-clé individuel lié au chercheur et à son travail
/autres-noms/[mettre le code]	Un nom supplémentaire individuel par lequel le chercheur est connu
/peer-review/[mettre le code]	Une activité individuelle d'évaluation par les pairs
/researcher-urls/[mettre le code]	Un lien externe individuel vers la page personnelle ou de profil du chercheur
/travail/[mettre le code]	Un travail de recherche individuel
/works/[mettre le code1],[mettre le code2],[mettre le code3]	Travaux de recherche individuels en vrac (jusqu'à 100)

À l'aide du point de terminaison de la section et du code put, vous pouvez appeler l'API à l'aide de votre même jeton d'accès pour obtenir l'intégralité de cet élément spécifique. Cet exemple d'appel récupère l'élément de financement complet 4413 au format XML à l'aide de l'API membre sur le serveur sandbox.

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

Exemple d'appel : GitHub

L'API renverra un message 200 OK pour indiquer que le message a été reçu avec succès et renverra le XML complet de l'élément de financement :

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

Vous pouvez vérifier la provenance d'un article en le lisant si vous voulez savoir qui l'a ajouté.

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.

ORCID les membres peuvent mettre à jour les informations qu'ils ont précédemment ajoutées à un ORCID enregistrer. Un seul élément peut être mis à jour à la fois, et il ne peut être mis à jour qu'à l'aide des informations d'identification client qui l'ont créé en premier lieu.

Pour faciliter la mise à jour, assurez-vous stocker le code d'accès et le jeton d'accès lors de la création d'éléments.

Formater l'élément mis à jour in ORCID schéma de message avec les informations modifiées et inclure les mettre le code.

<?xml version="1.0" encoding="UTF-8"?>      <employment:employment put-code="739288" [...]>     [...]            </employment:employment>

Appelez l'API :

Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288

Exemples d'appels : GitHub

L'API renverra un message 200 OK pour indiquer que l'élément a été mis à jour correctement. Consultez notre page de dépannage si un message différent est renvoyé.

La visibilité indique le paramètre de confidentialité de l'élément, en fonction des préférences de visibilité définies par l'utilisateur. Si une balise de visibilité est incluse lors de la publication d'informations via l'API, elle sera ignorée. Au lieu de cela, les informations seront publiées selon la préférence de visibilité par défaut de l'utilisateur définie dans les préférences de son compte.

Les éléments publics peuvent être lus par n'importe qui via l'API et sont affichés dans le dossier public du chercheur. Les éléments de partie de confiance ne sont renvoyés via l'API qu'aux clients disposant d'un accès limité en lecture ; ils ne figurent pas dans le dossier public du chercheur. Les éléments privés ne sont visibles que par le chercheur et la source de l'élément - les seuls éléments privés renvoyés via l'API sont ceux qui ont été ajoutés à l'enregistrement via votre intégration En savoir plus sur les paramètres de visibilité dans le ORCID Registre .

Des éléments (travaux, emploi, financement, évaluation par les pairs, etc.) peuvent être ajoutés à un ORCID enregistrer en utilisant le ORCID API membre. Pour ce faire, vous devez d'abord obtenir la permission du chercheur en utilisant OAuth et formater les métadonnées de l'élément en utilisant l' ORCID schéma des messages.

Une fois que vous avez formaté les données et collecté les ORCID iD et le jeton d'accès, vous effectuez une requête API à l'aide de HTTP POST, en spécifiant le point final pertinent.

Method: POST 
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add 
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment

L'appel ci-dessous ajoute une nouvelle emploi affiliation à un enregistrement sur le serveur de test sandbox :

<?xml version="1.0" encoding="UTF-8"?>      
<employment:employment [...]>     
[...]            
</employment:employment>

Exemple d'appel : Github

L'API renverra un message 201 pour indiquer que l'article a été publié correctement, ainsi que l'article mettre le code. Votre client sera répertorié comme le provenance de l'article.

Visitez notre dépannage page si un message différent est renvoyé. Vous devrez sauvegarder le  stocker le code d'accès et le jeton d'accès pour effectuer des mises à jour ou supprimer l'élément.

Votre ORCID L'API de recherche utilise la syntaxe SOLR. Toutes les syntaxes de requête disponibles dans SOLR 3.6 sont prises en charge, y compris Lucene avec les extensions Solr (Par défaut), DisMax et Extended Dismax.

Vous avez besoin d'un jeton d'accès «/ read-public» pour l'utiliser. Une fois que vous avez obtenu votre jeton de recherche, créez votre URL de recherche de base:

Type d'informations d'identification:	API publique	API des membres
URL de la ressource:	Bac à sable : https://pub.sandbox.orcid.org Réalisation : https://pub.orcid.org	Bac à sable : https://api.sandbox.orcid.org Réalisation : https://api.orcid.org
Version de l'API:	v3.0
Rechercher un point de terminaison	/ search /? = [requête]

Un exemple d'appel pour rechercher « orcid » avec le jeton sur l'API publique sandbox avec les résultats renvoyés au format XML est :

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

Les résultats spécifieront le nombre de résultats trouvés (num-found) et afficheront les 1000 premiers résultats par défaut:

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

Un exemple de recherche de base sur l'API publique sandbox avec des résultats renvoyés au format json:

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

La recherche ne renvoie que l'individu ORCID ID des enregistrements contenant des données publiques correspondant à la recherche. Pour obtenir plus d'informations sur le résultat, passez un appel pour lire le ORCID enregistrer directement.

Pour des informations plus détaillées, veuillez consulter Didacticiel de l'API de recherche.

Si vous avez ajouté des données qui doivent être supprimées, par exemple, si elles ont été associées au mauvais ORCID iD, alors vous pouvez faire une requête HTTP DELETE en spécifiant le paramètre pertinent, avec le ORCID identifiant, jeton d'accès stocké et code de mise stocké. Un seul élément peut être supprimé à la fois et vous ne pouvez supprimer que les éléments ajoutés par votre client. Vous pouvez supprimer des éléments même lorsque l'utilisateur a révoqué l'autorisation.

Cet exemple d'appel supprime l'élément d'emploi avec le code de vente « 739288 » d'un enregistrement »

Method: DELETE 
Content-type:  application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288

Exemple d'appel : GitHub

Votre ORCID L'API de recherche utilise la syntaxe SOLR. Toutes les syntaxes de requête disponibles dans SOLR 3.6 sont prises en charge, y compris Lucene avec les extensions Solr (Par défaut), DisMax et Extended Dismax.

Vous pouvez utiliser une recherche par champ lorsque vous avez besoin de rechercher une section spécifique du ORCID enregistrer. La liste actuelle des champs reconnus dans la recherche API, ainsi que leurs éléments de structure d'enregistrement correspondants, sont les suivants:

Champ de recherche	Description
Donnée biographique
prénoms	Le (s) nom (s) donné (s) de l'utilisateur.
nom de famille	Le (sur) nom de famille de l'utilisateur.
crédit-nom	Le «nom publié» sur le ORCID interface utilisateur, le nom qui apparaît normalement sur les publications par l'utilisateur
Autres noms	Noms alternatifs qui peuvent avoir figuré sur les publications de l'utilisateur.
email	L'adresse e-mail de l'utilisateur.
mot-clé	Tous les mots clés associés à l'utilisateur.
référence-id-externe	Identifiants d'autres systèmes ajoutés à l'utilisateur ORCID enregistrer à l'aide de l'API.
Données d'affiliation
nom-organisation-affiliation	Le nom de toute organisation dans un élément d'éducation ou d'emploi dans le dossier de l'utilisateur.
id-org-grille	Votre ID GRID de toute organisation dans la section activités du dossier de l'utilisateur. Généralement, cela sera associé à un élément d'éducation ou d'emploi.
ror-org-id	Votre ID ROR de toute organisation dans la section activités du dossier de l'utilisateur. Généralement, cela sera associé à un élément d'éducation ou d'emploi.
ringgold-org-id	Votre ID Ringgold* de tout organisme dans la section activités de la fiche de l'utilisateur. Généralement, cela sera associé à un élément d’éducation ou d’emploi.
Données de financement
titres-de-financement	Le titre de tout élément de financement dans le dossier de l'utilisateur.
fundref-org-id	Votre ID de registre Crossref Funder de toute organisation dans la section des activités de la fiche d'un utilisateur. Généralement, cela sera associé à un élément de financement, mais il peut également être associé à une affiliation.
numéros de subvention	Numéro de subvention (identifiant) de tout élément de financement dans le dossier de l'utilisateur.
Données des activités de recherche
titres de travail	Les titres de toute œuvre dans le dossier de l'utilisateur.
identifiants d'objets numériques	Un identifiant externe de travail de type doi
faire soi-même	Un identifiant externe de travail de type doi et la relation d'identifiant externe définie sur self
[type d'identifiant externe] *	Un identifiant externe de travail avec le type donné
[type d'identifiant externe] * - soi	Un identifiant externe de travail avec le type donné et la relation d'identifiant externe définie sur soi
[type d'identifiant externe] * - partie de	Un identifiant externe de travail avec le type donné et la relation d'identifiant externe définie sur part-of
[type d'identifiant externe] * - version de	Un identifiant externe de travail avec le type donné et la relation d'identifiant externe définie sur version-de * Pour une liste complète des identifiants externes, consultez le liste d'identifiants. Certains identifiants peuvent nécessiter « -self », « -part-of » ou « -version-of » pour renvoyer des résultats
ORCID enregistrer des données
orcide	Les 16 chiffres ORCID identifiant de l'utilisateur, au format 0000-0001-2345-6789.
profil-date-de-soumission	La date et l'heure de création de l'enregistrement.
profil-date-de-dernière-modification	La date et l'heure de la dernière modification de l'enregistrement.
Toutes les données
texte	Tous les champs ci-dessus. Il s'agit également du champ par défaut pour les requêtes de syntaxe Lucene.

Découvrez nos offres de Tutoriel de recherche sur l'API pour plus d'information.

*Bien que les identifiants Ringgold existent toujours au sein du ORCID registre, à compter du 1er août 2023, ORCID ne reçoit plus de mises à jour de la base de données d'identifiants d'organisation RINGGOLD utilisée par notre registre, et nous ne pourrons pas non plus traiter ou utiliser les identifiants RINGGOLD créés après cette date. Voir notre QFP pour plus d'informations

Dans des situations réelles, les interactions API sont complétées par votre système à l'aide d'un langage de programmation tel que PHP, Java ou Ruby on Rails. Pour la pratique et les tests, vous pouvez interagir avec le ORCID Des API utilisant une gamme d'outils capables de créer et de recevoir des requêtes HTTP. La plupart des outils HTTP de bureau sont exécutés en ligne de commande ; pour ceux qui préfèrent une interface graphique, les outils Web sont une alternative utile.

VÉRIFICATION XML/XSD

Il existe de nombreux outils qui vérifieront votre XML pour vous ; c'est une bonne idée d'en adopter un. Pour la plupart des appels d'API, vous travaillerez avec des informations au format XML. En particulier lorsque vous travaillez avec le ORCID Message API, il sera important que le XML que vous utilisez soit valide par rapport au XSD. (Voir notre documentation sur GitHub pour ORCID schéma de message XSD.)

ORCID SERVEUR DE TEST SANDBOX

Votre serveur de test sandbox est une copie du ORCID Logiciel de registre, et ne contient que des données de test. Il a été conçu pour fournir un endroit pour essayer des choses sans affecter aucun réel ORCID iDs, en particulier si vous travaillez avec le ORCID API et avez besoin d'un endroit pour tester votre travail. Vous pouvez créer des comptes d'utilisateurs et tester les appels d'API sur le bac à sable sans avoir à vous soucier d'affecter les données de production ou de spammer accidentellement les chercheurs.

Vous n'avez même pas besoin d'être un ORCID membre pour essayer l'API membre dans le bac à sable. Tous sont invités à demander les informations d'identification de l'API membre sandbox et à essayer toutes les fonctionnalités disponibles pour l'API membre.

Le site et les API ne seront pas aussi fiables que pour les serveurs de production. Nous ne donnons aucune garantie concernant les données sur le bac à sable ; ils ne sont pas sauvegardés et peuvent être supprimés. Le bac à sable peut également contenir des fonctionnalités expérimentales qui ne sont pas encore sur les serveurs de production afin que vous puissiez essayer des choses avant qu'elles n'existent dans le registre. Apprendre encore plus sur le serveur de test sandbox ou demander les informations d'identification du client.

OUTILS HTTP

Il existe de nombreux outils disponibles pour exécuter des requêtes HTTP. Certains que nous utilisons :

• cURL
• poster
• wget
• lance.it
• Aire de jeu Google OAuth 2.0
• Fanfaronnade : API membre (bac à sable), API publique (bac à sable)

Les webhooks peuvent être enregistrés par les membres premium contre n'importe quel ORCID enregistrer dans le registre. Les étapes sont :

Encoder l'URL

URL-encoder l'URL que vous voulez ORCID à appeler lorsque le dossier de l'utilisateur est mis à jour. Par exemple l'URL suivante :

https://nowhere2.com/0000-0002-7465-2162/updated

devient

https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated

Construire l'URL

Créez l'URL complète pour le ORCID Appel d'API commençant par l'URL du ORCID enregistrez puis ajoutez ‚√∫/webhook‚√π et l'URL que vous souhaitez appeler. Cela devrait donc ressembler à https://api.sandbox.orcid.org/{ORCID}/webhook/{URL-ENCODÉ-WEBHOOK-URL}

Par exemple, en utilisant l'URL du webhook ci-dessus et le ORCID iD 0000-0002-7465-2162, l'URL complète est :

https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated

Enregistrer le webhook

Utilisez vos webhooks‚ jeton d'accès pour enregistrer votre webhook auprès de l'utilisateur ORCID enregistrer. Vous devez utiliser une requête HTTP PUT, mais vous ne devez rien inclure dans le corps de la requête.

URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn   HEADER: Accept: application/json   HEADER: Authorization: Bearer [Your access token]n   HEADER: Content-Length: 0n   METHOD: PUT

La réponse doit être un 201, mais si le rappel existait déjà, alors la réponse sera 204.

HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5

L'URL pour désinscrire un webhook est la même que pour l'inscription. Cependant, vous devez utiliser la méthode HTTP DELETE.

URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
   HEADER: Authorization: Bearer [Your access token]
   HEADER: Content-Length: 0
   METHOD: DELETE

La réponse doit être 204 No Content.

HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT

Votre ORCID Le registre effectuera l'appel HTTP suivant lorsqu'un enregistrement est mis à jour. La requête utilise la méthode HTTP POST, mais le corps de la requête est vide.

curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated

Votre serveur doit répondre avec des codes de réponse HTTP standard. Ainsi, si l'appel a réussi, vous devez renvoyer 204 No Content.

HTTP/1.1 204 No Content

Tout code de réponse 2xx signifie que l'appel a réussi. Si vous retournez un code qui n'est pas un 2xx, nous réessayerons l'appel cinq minutes plus tard.

Dans des situations réelles, les interactions API sont complétées par votre système à l'aide d'un langage de programmation tel que PHP, Java ou Ruby on Rails. Pour la pratique et les tests, cependant, vous pouvez interagir avec le ORCID API utilisant une gamme d'outils capables de faire et de recevoir des requêtes HTTP. La plupart des outils HTTP de bureau (tels que cURL) sont exécutés dans la ligne de commande ; pour ceux qui préfèrent une interface graphique, les outils Web sont une alternative utile.

Un outil populaire est Le terrain de jeu OAuth 2.0 de Google, un outil Web gratuit développé et géré par Google.

Veuillez consulter notre didacticiel pratique sur l'API à l'adresse suivante : https://info.orcid.org/hands-on-with-the-orcid-api/

Remarque : ORCID ne gère pas le OAuth 2.0 Playground - cet outil a été créé par Google, qui gère exclusivement son code. Bien que nous mettions périodiquement à jour cette documentation, il peut y avoir des inexactitudes de temps à autre, car nous pouvons ne pas être immédiatement informés des modifications apportées à OAuth 2.0 Playground.

Pour notre API version 2.0 et supérieure, les limites sont :

• Demander une seconde – 24
• Rafale – 40

Demander une seconde – Nombre de demandes qui peuvent être faites une seconde.

Burst – Nombre de demandes que nous autoriserons à être mises en file d'attente avant de les rejeter. Les requêtes dans la file d'attente sont ralenties au taux de requêtes par seconde. Si vous dépassez la rafale, vous obtiendrez une réponse 503.

Si vous rencontrez des problèmes avec les limites, veuillez contacter votre responsable de l'équipe d'engagement pour obtenir de l'aide.

Le contrôle du chercheur est un noyau ORCID principe donc les adresses e-mail enregistrées et ajoutées au ORCID sont, par défaut, définis comme visibles uniquement par le détenteur de l'enregistrement. Les e-mails non vérifiés ne s'affichent pas dans la vue publique de l'enregistrement et seules les adresses e-mail qui ont été vérifiées apparaîtront dans les résultats de l'API.

Une fois que les chercheurs ont vérifié leur adresse e-mail, ils doivent choisir de la rendre visible à tous (c.

Si le chercheur a défini son adresse e-mail sur Parties de confiance, elle sera renvoyée avec le dossier si le chercheur vous a accordé accès limité en lecture. Pour plus d'informations, voir ORCID paramètres de visibilité.

L'API 3.0 est la version par défaut de l'API et nous vous recommandons d'utiliser cette version lors de la création de nouvelles intégrations. Nous continuerons à prendre en charge les API 2.0 et 2.1 dans un avenir prévisible et nous fournirons un préavis d'au moins 12 mois avant de désactiver ces versions.

Nous avons beaucoup appris lors de la transition de l'API 1.2 à l'API 2. Cette fois, nous avons rendu la mise à niveau beaucoup plus facile à gérer. L'API 3.0 ajoute de nouvelles fonctionnalités tout en ne modifiant les fonctionnalités existantes que lorsque cela est absolument nécessaire. Cela signifie que les intégrateurs devraient être en mesure de passer à la nouvelle API avec un minimum de tracas. Cela signifie également que, même si nous vous recommandons de commencer à planifier votre mise à niveau dès que possible afin que votre organisation et vos chercheurs puissent bénéficier des nouvelles fonctionnalités, vous disposez d'une grande flexibilité pour décider quand effectuer la mise à jour vers la 3.0.  

La petite liste des changements potentiellement décisifs se trouve dans nos notes de version de l'API ici et ici. Il y a quelques changements concernant les champs facultatifs/obligatoires, les énumérations JSON ont été légèrement modifiées, et nous avons également une petite refactorisation de nos schémas XML, ajoutant de nouveaux champs pour contenir les métadonnées requises pour la nouvelle fonctionnalité.

S'il vous plaît voir le ORCID Page des systèmes activés par le fournisseur pour les éditeurs pour les informations les plus récentes

Tout membre premium peut obtenir un jeton d'accès '/webhook'. Un seul jeton peut être utilisé pour enregistrer des webhooks pour plusieurs enregistrements. Pour obtenir un jeton, vous appelez le ORCID Point de terminaison du jeton API. 

Ce processus est souvent appelé flux OAuth des informations d'identification du client ou OAuth en 2 étapes.

Vous trouverez ci-dessous un exemple d'appel pour obtenir le jeton d'accès - remplacez les espaces réservés par vos informations d'identification (assurez-vous de supprimer les crochets.)

curl -i -L -H "Accept: application/json"
  -d "client_id=(your client ID)"
  -d "client_secret=(your client secret)"
  -d "scope=/webhook"
  -d "grant_type=client_credentials"
  "https://sandbox.orcid.org/oauth/token"

Vous recevrez alors un jeton d'accès semblable au suivant.

{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
  "token_type":"bearer",
  "refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
  "expires_in":631138518,
  "scope":"/webhook"}

Oui! Vous pouvez en savoir plus sur la gestion des versions de notre API, la justification qui la sous-tend et plus encore, ici sur notre Politique de version de l'API.

Alors que nous continuons à développer nos produits, un certain nombre de fonctionnalités ne sont disponibles qu'avec l'API 3.0, qui est notre dernière version d'API par défaut.

Le tableau ci-dessous fournit une brève description de chaque fonction. Si vous avez des questions concernant l'une des fonctionnalités ou la mise à niveau vers 3.0, veuillez contacter votre responsable d'engagement ou votre responsable de consortium.

Capacité de lire et d'écrire tous les types d'affiliation (l'adhésion, le service, les postes invités, les distinctions et les qualifications ne sont pas disponibles avec les versions précédentes de l'API)

Capacité de lire et d'écrire des ressources de recherche.

Capacité de lire et d'écrire des identifiants de travail avec le type de relation « Financé par ». Ceci est utilisé pour lier les ID de subvention ou de proposition aux métadonnées de travail.

Capacité de lire et d'écrire des identifiants de travail avec le type de relation « Version de ». Ceci est utilisé pour lier d'autres versions de l'œuvre entre elles. Un exemple de cas d'utilisation serait de lier la préimpression et l'article publié.

Capacité de lire et d'écrire des rôles CRediT dans les métadonnées des travaux.

Possibilité de lire les champs sources supplémentaires commun:assertion-origin-client-id et commun:assertion-origin-name pour les affiliations ajoutées par le ORCID portail des membres et travaux ajoutés par les assistants de recherche et de lien.

Capacité à lire et à écrire fonctionne avec le type de travail de : annotation plans-de-gestion-des-données thèse Dissertation pré-impression objet physique évaluation

Capacité de lire et d'écrire des identifiants externes pour les affiliations.

Les identifiants d'organisation sont obligatoires pour ajouter des affiliations et des financements à ORCID Records.

Formalisation des identifiants – Nous avons introduit un nouveau champ généré par le système, qui exprime les identifiants externes (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN et ISBN) dans un format normalisé à des fins de correspondance et de regroupement. La normalisation est effectuée sur la base des règles du type d'identifiant et peut inclure la définition de tous les caractères alpha en minuscules ou la transformation d'espaces, de tirets, de points et d'autres caractères pouvant être traités comme équivalents. Il ajoute également des préfixes et suffixes standard, le cas échéant. Par exemple, https://doi.org/10.1/123, 10.1/123 et https://dx.doi.org/10.1/123 apparaîtront tous dans ce champ comme https://doi.org/10.1/123. La valeur de l'identifiant existant n'est pas modifiée.

Des informations plus détaillées peuvent être trouvées ici.

Ils reçoivent une notification dans leur ORCID boîte de réception. Chaque fois qu'il y a un changement dans les données d'un ORCID enregistrement, l'utilisateur reçoit une notification avec des informations de base sur le changement, y compris le nom du client effectuant la mise à jour, la date du changement et l'élément dans le ORCID enregistrement qui a été mis à jour. Voir notre base de connaissances utilisateur pour en savoir plus sur les notifications.  

ORCID les enregistrements sur le bac à sable ont également boîtes de réception fonctionnelles. Nous vous recommandons de parcourir régulièrement les boîtes de réception de vos tests ORCID enregistrements lors de la planification de la façon dont vos systèmes planifieront les mises à jour des données. 

Les mises à jour et autres annonces pour les utilisateurs de l'API sont partagées via le ORCID Groupe d'utilisateurs de l'API. Vous pouvez également vous abonner aux messages généraux et aux mises à jour via le ORCID Blog.

ORCID les membres reçoivent également le ORCID Newsletter des membres où ces informations sont incluses. Enfin, le contact technique pour toute ORCID membre avec une intégration active et personnalisée recevra également des messages électroniques sur les mises à jour critiques de la ORCID Enregistrement. Si vous souhaitez être répertorié comme contact technique pour votre organisation, veuillez Nous contacter.

ORCID s'engage à être ouvert et transparent. Cela signifie que notre feuille de route produit est accessible à tous, tout comme le travail actuellement en développement.

La feuille de route produit est au cœur de la ORCID processus de développement de produits. Les exigences voyagent des tableaux trello gérés par l'équipe, en passant par le tableau trello de la feuille de route du produit, puis vers le tableau trello de développement actuel, où ils sont mis en œuvre et déplacés vers nos systèmes de production.

Ce tableau contient des exigences bien définies dont la mise en œuvre est prévue à un moment donnéet une liste des exigences prioritaires dont la mise en œuvre est prévue à court terme.

D'où viennent les exigences?

Les exigences sont recueillies à partir de nombreuses sources par ORCID Personnel. Ils peuvent provenir de demandes de membres, de commentaires de consortium, de tests utilisateurs, de projets stratégiques et de rapports de bogues, entre autres. De plus, tout ORCID les équipes génèrent leurs propres exigences internes, telles que les modifications du site Web, les mises à niveau de l'infrastructure et les mises à jour des systèmes opérationnels. Chaque carte est étiquetée avec l'équipe qui a produit l'exigence - communications, stratégie, technologie, engagement ou opérations.

Comment ça se passe sur la feuille de route?

ORCID vise un cycle de développement de produits équilibré et organise régulièrement des réunions inter-équipes pour discuter des priorités à court et à long terme. Nous faisons de notre mieux pour résoudre les bugs, les nouvelles fonctionnalités, la dette technique, les mises à jour du site Web et les éléments stratégiques de la même manière.

Comment puis-je contribuer à la feuille de route?

Nous accueillons avec plaisir les suggestions sur la façon d'améliorer le ORCID enregistrement. Veuillez envoyer vos commentaires à notre équipe.

Par ailleurs, ORCID est un projet open source et nous accueillons les contributions à notre code source ainsi que tous nos référentiels.

Une prépublication est un manuscrit scientifique complet qui est téléchargé par les auteurs sur un serveur public. La prépublication contient des données et des méthodologies complètes ; c'est souvent le même manuscrit qui est soumis à une revue. Après une brève inspection de contrôle de la qualité pour s'assurer que le travail est de nature scientifique, le manuscrit de l'auteur est publié dans un délai d'environ un jour sur le Web sans examen par les pairs et peut être consulté gratuitement par n'importe qui dans le monde. Sur la base des commentaires et/ou de nouvelles données, de nouvelles versions de votre prépublication peuvent être soumises ; cependant, les versions préimprimées antérieures sont également conservées. Les serveurs de prépublication permettent aux scientifiques de contrôler directement la diffusion de leurs travaux à la communauté scientifique mondiale. Dans la plupart des cas, le même travail publié en tant que prépublication est également soumis à un examen par les pairs dans une revue. Ainsi, les prépublications (rapides, mais non validées par peer-review) et la publication de revues (lente, mais fournissant une validation par peer-review) fonctionnent en parallèle comme un système de communication pour la recherche scientifique.

Regardez la vidéo sur YouTube

Remarque : Ce contenu et cette vidéo sont apparus à l'origine sur le Site web de l'ASAPBio Merci à ASAPBio de l'avoir mis à disposition sous licence CC-BY !

La newsletter des membres envoyée mensuellement de ORCID contenait auparavant un lien vers un dossier Google Drive où tous vos rapports de membres étaient stockés. Cela a maintenant été remplacé par de nouveaux rapports disponibles pour tous les membres de la portail des membres.

Rapports précédents :

• Membres Premium avec intégrations actives recevez un lien unique vers un dossier contenant des rapports séparés et personnalisés avec des données pour chaque intégration du mois précédent.
• Membres Premium qui n'ont pas encore d'intégration active recevoir un lien unique vers un dossier contenant des rapports personnalisés avec des statistiques par e-mail pour leur institution, ainsi qu'un lien vers un dossier qui contient des rapports généraux avec des données agrégées pour toutes les intégrations de membres actifs.
• Membres de base recevoir un lien vers un dossier contenant des rapports généraux publiés deux fois par an avec des données agrégées pour toutes les intégrations de membres actifs au cours du semestre précédent ; le rapport du premier semestre est publié en Juillet (données janvier-juin), le rapport du second semestre publié en Janvier (juillet-décembre de l'année suivante).

Si vous êtes un ORCID membre et ne recevez pas actuellement la newsletter mensuelle des membres, veuillez contacter [email protected]

Membres Premium avec intégrations actives

Le dossier Google Drive contient un rapport de membre pour chacun des ID client de production qui vous ont été délivrés. Les noms de fichiers incluent le nom d'affichage du client iD et la date du rapport; veuillez trier par date de modification pour trouver le rapport le plus récent. Il existe également un dossier raw_data contenant les données utilisées pour générer le rapport, qui est disponible pour une analyse supplémentaire si nécessaire.

Membres Premium qui n'ont pas encore d'intégration active

Le dossier Google Drive contient un rapport de membre avec des données statistiques par e-mail uniquement, ainsi qu'un lien vers un dossier Google Drive de rapports mensuels généraux avec des données agrégées pour toutes les intégrations de membres actifs, pour l'année en cours et les années précédentes. Les données brutes ne sont pas disponibles pour ces rapports.

Nombre de domaines de messagerie

Cette section fournit des comptes de ORCID iDs a actuellement enregistré le(s) domaine(s) de messagerie de votre établissement sur toutes les périodes. Pour générer ces décomptes, nous recherchons les domaines qui correspondent à l'URL du site Web que nous avons enregistrée pour votre organisation (par exemple : si l'URL de votre site Web est www.universitycollege.edu, nous recherchons les e-mails se terminant par @universitycollege). Si nous n'avons pas d'URL de site Web dans nos fichiers, vous verrez ‚√∫Aucun domaine de messagerie fourni‚√π dans cette section. Si nous n'avons pas bien défini votre domaine de messagerie, ou si vous souhaitez ajouter des domaines supplémentaires, veuillez Nous contacter.

• Enregistrements enregistrés dans vos domaines de messagerie¬¨‚Nombre de ORCID ID qui incluent une adresse dans le(s) domaine(s) de messagerie de votre établissement
• Enregistrements enregistrés dans vos domaines de messagerie ET associés à votre identifiant client¬¨‚Nombre de ORCID ID qui incluent une adresse dans le(s) domaine(s) de messagerie de votre établissement ET qui incluent votre établissement en tant que partie de confiance (c'est-à-dire : les enregistrements pour lesquels votre établissement dispose d'un jeton d'accès valide)

Enregistrements créés et réclamés

(Remarque : la plupart des clients n'auront pas cette section dans leurs rapports)

Si vous avez un client institutionnel qui a été utilisé pour créer des enregistrements pour le compte de chercheurs via l'API, vous recevrez une section intitulée Registry Statistics. Cela inclut des informations sur le nombre d'enregistrements que vous avez créés et combien ont été réclamés (le fichier raw_data contient plus d'informations sur les enregistrements spécifiques utilisés pour générer ces nombres).

Utilisateurs

Cette section du rapport contient un décompte total du nombre de chercheurs qui ont utilisé votre intégration pour connecter leurs ORCID iD à votre système au cours du mois de déclaration. De plus, il donne le nombre total de chercheurs qui se sont inscrits à un nouveau ORCID iD dans le cadre du iD processus de connexion. 

Le graphique intitulé Nombre total d'événements d'intégration montre le nombre de chercheurs qui ont utilisé votre intégration au cours du dernier mois, par jour

Événements

Le rapport contient également l'évènementiel informations, les actions que le chercheur a effectuées lors de la connexion de leurs ORCID enregistrer avec votre système dans le mois du rapport. Chaque événement représente tout accès accordé par l'utilisateur ou toute action qu'il a effectuée sur le ORCID (par exemple, vous connecter ou donner un accès limité en lecture). La plupart des chercheurs auront plus d'un événement qui leur est associé.

Si un événement est suivi d'un ‚√∫√π, cela signifie que le chercheur a accordé une longue durée de vie (Ppersistant), par rapport à un jeton de courte durée qui expire dans une heure. Depuis mars 2018, seuls les jetons à longue durée de vie sont pris en charge sur le ORCID Enregistrement; votre système intégré ou l'utilisateur peut choisir de révoquer le token à tout moment. 

Utilisateurs par pays

La dernière section des rapports contient des informations sur les chercheurs qui ont utilisé votre intégration, réparties en fonction du pays à partir duquel ils ont accédé à votre intégration. Ces données sont dérivées de l'adresse IP d'un chercheur ou de son identifiant géographique (lui-même déterminé par Google à partir de l'adresse IP du chercheur).

Échantillonnage

Parce que tant de chercheurs utilisent le ORCID Registre, il n'est pas possible de générer des rapports sur l'ensemble des données des chercheurs. Au lieu de cela, les chiffres fournis ici sont produits en utilisant les tendances d'un ensemble échantillonné et non échantillonné. Les sections du rapport dérivées des données échantillonnées sont signalées par un astérisque, et la taille et l'espace échantillonnés sont spécifiés dans l'onglet Données analytiques. Les chiffres de la section Google Analytics du rapport peuvent ne pas correspondre entièrement aux statistiques locales que vous conservez, et il peut y avoir de petites différences dans le décompte entre les sections du rapport.

Les paramètres d'échantillonnage répertoriés sous Integration Analytics s'appliquent à toutes les sections marquées d'un astérisque. Le pourcentage de sessions capturées par les données d'analyse est (taille de l'échantillon)/(espace de l'échantillon) * 100 %. Vous trouverez de plus amples informations sur l'échantillonnage sur Google Développeurs.

Rapports vides

Les sections Utilisateurs et Événements du rapport incluent uniquement les données du mois dernier. Si aucun chercheur n'a utilisé votre intégration au cours du mois dernier, aucune donnée ne sera renvoyée.

questions

Si vous avez des questions concernant vos rapports de membres, veuillez Nous contacter.

Votre ORCID Le registre est conçu pour que les utilisateurs fournissent leurs identifiants aux organisations utilisant OAuth, ce qui garantit que le bon iD est collecté pour chaque chercheur. Nous décourageons les organisations d'ajouter ORCID iDs à leurs systèmes sur la base d'une recherche de chercheurs par nom. Cependant, il peut être utile de savoir combien de chercheurs de votre organisation ont ORCID iDs, ce qui peut être fait via l'API. Des suggestions de recherche par organisation sont données ci-dessous.

Pour une introduction à la recherche, comment obtenir un jeton d'accès, comment comprendre vos résultats de recherche et les détails des autres champs qui peuvent être recherchés, veuillez consulter notre Recherche dans le didacticiel de l'API du registre

Recherche par nom et DOI

Lorsqu'on vérifie si une personne a un ORCID record, nous vous recommandons de rechercher à la fois par leur nom et le DOI d'une ou plusieurs de leurs œuvres récentes. Cela devrait aboutir uniquement au dossier du chercheur que vous recherchez, et non aux dossiers de toute autre personne qui partage le même nom.

Un exemple d'appel pour rechercher tous les enregistrements portant le nom « Laurel Haak » et le DOI 10.1087/20120404 ou le DOI 10.6084/M9.FIGSHARE.1115124 : 

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22

Recherche par affiliation

Les champs d'affiliation peuvent être recherchés en utilisant soit le nom de l'affiliation, soit l'ID ROR ou l'ID GRID unique de l'organisation. (Vous pouvez trouver l'ID GRID de votre organisation dans GRID ou votre identifiant ROR dans le Registre ROR)

Recherche par nom d'organisation

Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token] 
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg" 

Ou pour une correspondance exacte

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)

Recherche par ID GRID

Un exemple d'appel pour rechercher tous les enregistrements avec l'ID GRID grid.5509.9 (Université de Tampere) :

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9

Recherche par ID ROR

Un exemple d'appel pour rechercher tous les enregistrements avec l'ID ROR 04fa4r544 (ORCID):

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"

Recherche par domaine de messagerie

Vous pouvez utiliser l'API pour rechercher des chercheurs par domaine de messagerie. Gardez à l'esprit qu'environ 97% des adresses e-mail dans ORCID sont privés et tous les enregistrements avec une adresse e-mail d'accès privé ou de confiance ne seront pas renvoyés dans cette recherche.

Un exemple d'appel pour rechercher tous les enregistrements avec une adresse e-mail @orcid.org :

Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL:  https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org

Résultats de la recherche renvoyés au format CSV

Les résultats de la recherche peuvent également être renvoyés au format CSV. Dans le cadre de l'appel, vous pouvez spécifier les colonnes de sortie à partir d'une liste de champs disponibles ci-dessous:

orcide
email
prénom
nom de famille
prénoms et noms de famille
crédit-nom
autre nom
nom-d'affiliation-institution-actuel
ancien-nom-affiliation-institution 

En utilisant vos informations d'identification, vous devez spécifier que l'en-tête soit 'texte / csv '. Dans le cadre de l'appel de recherche, vous devez également ajouter les champs dont vous avez besoin dans la sortie de la requête.  

Recherche en utilisant uniquement votre navigateur

Vous pouvez également effectuer la recherche à l'aide de votre navigateur. L'URL est construite de la même manière, mais vous n'avez pas besoin d'utiliser les informations d'identification d'API. Veuillez noter que cela ne peut être effectué qu'à l'aide de l'API publique. 

Vous trouverez ci-dessous un exemple d'appel utilisant l'API publique recherchant par nom d'organisation avec le ORCID, prénoms, noms de famille, nom d'affiliation institutionnelle actuelle et ancien nom d'affiliation institutionnelle comme résultat souhaité. 

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

Vous trouverez ci-dessous un autre exemple d'appel utilisant l'API publique recherchant selon différentes variantes du nom de l'organisation.

https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")

Le schéma eduPerson a ajouté le eduPersonOrcid attribut dans son Mise à jour de février de 2016.

Selon le Spécification eduPerson:

  RFC4512  definition
  ( 1.3.6.1.4.1.5923.1.1.1.16
  NAME 'eduPersonOrcid'
  DESC 'ORCID researcher identifiers belonging to the principal'
  EQUALITY caseIgnoreMatch
  SYNTAX  '1.3.6.1.4.1.1466.115.121.1.15' )

Notez que le format de ce champ est le ORCID-représentation URI préférée de l'iD, À savoir https://orcid.org/0000-0001-5727-2427.

Plus d'informations sur le format de la ORCID iD peuvent être trouvés dans Structure du ORCID identifiant.

ORCID a été fondée sur le principe que les chercheurs devraient avoir le contrôle de leurs informations. Pour honorer ce principe, nous avons une forte Politique de confidentialité, qui a été conçu pour tenir compte des variations locales des réglementations en matière de confidentialité, et nous nous concentrons sur le point de vue du chercheur lors de l'élaboration des politiques et des fonctionnalités.

En accord avec notre principe de base du contrôle du chercheur, ORCID les dossiers ne peuvent être créés que par les chercheurs eux-mêmes, sur le ORCID en ligne.

Dans le cadre de votre workflow d'intégration, vos chercheurs pourront s'inscrire à un nouveau ORCID iD ou connectez-vous à leur dossier existant vous permettant de collecter leurs informations authentifiées ORCID identifiant. Veuillez consulter notre Tutoriels API pour plus d'information.

Si vous pensez que les données figurant sur votre rapport sont inexactes, veuillez Nous contacter avec autant de détails que possible et notre équipe d'engagement enquêtera.

Si votre organisation est une ORCID membre, vous devez contacter le ORCID contact au sein de votre organisation qui pourra vous donner accès au ORCID Portail des membres. Si vous ne parvenez pas à identifier vos organisations ORCID contactez, veuillez contacter votre responsable du consortium ou votre représentant de l'équipe d'engagement.

Nous aimons les commentaires de notre communauté, alors faites-nous savoir si vous avez des commentaires sur les rapports des membres en nous contactant à https://support.orcid.org/hc/en-us/requests/new

Nous avons compilé un guide pour vous guider à travers chaque section des rapports. Le guide peut être trouvé ici.

Les données utilisées pour produire les rapports de membre et d'intégration sont mises à jour quotidiennement.