étapes 2 5 (de XNUMX)
2. Collecte authentifiée ORCID identifiants et autorisations
Dans cette étape, découvrez comment obtenir un compte authentifié iD et l'autorisation nécessaire pour lire et écrire des données vers et depuis un ORCID record.
ORCID les intégrations utilisent "OAuth à 3 étapes” pour authentifier les utilisateurs et demander l'autorisation d'interagir avec leurs enregistrements. ORCID les membres peuvent utiliser l'API des membres pour demander des autorisations de lecture et d'écriture.
Dans cette section, nous allons parcourir les étapes que votre propre intégration personnalisée devrait suivre pour obtenir un compte authentifié iD et l'autorisation de lire et d'écrire à un ORCID record
Obtenir un authentifié iD et l'autorisation d'accès à l'enregistrement d'un utilisateur implique de suivre OAuth 2.0, un protocole d'autorisation standard de l'industrie. OAuth permet à un utilisateur de donner à un site Web ou à une application l'accès aux informations de compte stockées sur un autre site, sans donner à ce site son mot de passe.
Si vous vous êtes déjà connecté à un site en utilisant Google ou Facebook au lieu de vos informations d'identification pour ce site particulier, vous avez déjà utilisé OAuth !
Le processus OAuth comprend 3 étapes :
- Créer une URL d'autorisation
- Obtenir un code d'autorisation
- Échangez le code d'autorisation contre un jeton d'accès
Pour lancer le processus OAuth, nous devrons créer une URL d'autorisation spéciale qui envoie les utilisateurs vers un ORCID écran de connexion. Cette URL se compose de Point de terminaison d'autorisation, ainsi que Paramètres qui identifient votre organisation et les autorisations que vous souhaitez demander.
| Paramètre | Description | Exemple |
|---|---|---|
| type_réponse | code | |
| portée | Action(s) d'API pour laquelle vous souhaitez demander l'autorisation, dans la liste des ORCID Scopes | /personne/mise à jour /activités/mise à jour /Lire-limité /authentifier |
| client_id | Votre client Membre ID (délivré par ORCID) | [APP-***] |
| URL de redirection | Page que les utilisateurs verront après avoir terminé le processus d'autorisation. (Pour ce tutoriel, ce sera Google OAUth Playground) | https://developers.go ogle.com/oauthplayground |
Pour demander l'autorisation d'ajouter/mettre à jour des activités (affiliations, financement, travaux, évaluation par les pairs, ressources de recherche) et d'ajouter/mettre à jour des éléments personnels (autres noms, mots clés, pays, URL de chercheur, sites Web et identifiants externes personnels) et lire le ORCID record, l'URL d'autorisation sera :
https://sandbox.orcid.org/oauth/authorize?client_id=[APP-****************]&response_type=code&scope=/read-limited%20/activities/update%20/person/update&redirect_uri=https://developers.google.com/oauthplaygroundMais nous pouvons utiliser Google OAuth playground pour nous aider à créer l'URL d'autorisation
- Ajoutez /activities/update, /person/update, /read-limited dans le champ scopes et cliquez sur Authorize API's.
L'URL d'autorisation aurait été créée à l'aide des informations que vous avez saisies dans les champs de configuration et de portée.
- An ORCID l'écran de connexion apparaîtra ; connectez-vous à votre compte Sandbox avec l'adresse e-mail et le mot de passe que vous avez utilisés pour créer votre ORCID compte au début de ce didacticiel. Une fois connecté, l'écran OAuth apparaîtra. Le nom du client et les portées pertinentes s'afficheront sur cet écran. Pour accorder l'accès, vous devez cliquer sur 'Autoriser l'accès'
- Après avoir accordé l'autorisation, vous serez redirigé vers Google OAuth Playground car il s'agissait de l'URI de redirection associée à vos informations d'identification Sandbox. Un code d'autorisation à 6 caractères apparaîtra à la fin de l'URI de redirection dans la barre d'adresse du navigateur (et sous le Étape 2 section à gauche de la page dans google oauth playground)
Secure https://developers.google.com/oauthplayground/code=s536Z5Échangez le code d'autorisation pour le jeton d'accès et l'ID authentifié
Une fois que vous avez un code d'autorisation, vous pouvez l'échanger contre un jeton d'accès et le code d'authentification authentifié. iD de l'utilisateur qui s'est connecté, dont vous aurez besoin pour effectuer la ou les actions d'API pour lesquelles vous avez demandé l'autorisation.
Dans une situation réelle, cet échange serait effectué par votre système, à l'aide d'un langage de programmation tel que PHP, Java ou Ruby on Rails. Pour ce didacticiel, nous utiliserons Google OAuth Playground pour simuler une application Web.
- Cliquez 'Code d'autorisation d'échange pour les jetons'
Une fois que vous cliquez sur “Code d'autorisation d'échange pour les jetons” Votre jeton d'accès et authentifié iD apparaîtra dans le Demande de réponse partie à droite. Veuillez voir l'exemple ci-dessous :
{
"name": "Sophia Garcia"
"access_token": "53737721-9cdb-442a-8b77-409609bb5e43",
"expires_in": 631138518,
"token type": "bearer",
"orcid":
"0000-0002-4456-8947"
"scope": "read-limited /activities/update person/update "
"refresh token": "cOfc38fd-291e-4633-a365-6f4afa304344"
}- Enregistrez ce jeton !
Il est important de sauvegarder le jeton que vous avez reçu à l'étape ci-dessus car vous pouvez facilement créer tous les appels que vous devez passer avec. Nous vous recommandons de stocker la réponse d'échange de jeton complète
Vous avez maintenant collecté un Authentifié ID et l'autorisation de l'utilisateur de lire son ORCID enregistrer et mettre à jour leurs ORCID record.