Commencer votre intégration

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.

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

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

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.

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 du système 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 du 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 du 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.

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.

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

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