step 2 (del 5)
2. Raccogli autenticato ORCID ID e autorizzazioni
In questo passaggio, scopri come ottenere un file Authenticated iD e l'autorizzazione necessaria per leggere e scrivere dati da e verso un ORCID record.
ORCID le integrazioni usano "OAuth a 3 zampe” per autenticare gli utenti e richiedere il permesso di interagire con i loro record. ORCID i membri possono utilizzare l'API membro per richiedere autorizzazioni di lettura e scrittura.
In questa sezione, illustreremo i passaggi che la tua integrazione personalizzata dovrebbe completare per ottenere un'autenticazione iD e il permesso di leggere e scrivere ad an ORCID record
Ottenere un file Authenticated iD e l'autorizzazione di accesso alla registrazione da parte di un utente implica il seguente OAuth2.0, un protocollo standard del settore per l'autorizzazione. OAuth consente a un utente di concedere a un sito Web oa un'applicazione l'accesso alle informazioni sull'account archiviate su un altro sito, senza fornire a tale sito la propria password.
Se hai mai effettuato l'accesso a un sito utilizzando Google o Facebook invece delle tue credenziali per quel particolare sito, hai già utilizzato OAuth!
Il processo OAuth comprende 3 fasi:
- Crea un URL di autorizzazione
- Ottieni un codice di autorizzazione
- Scambia il codice di autorizzazione con un token di accesso
Per avviare il processo OAuth, dovremo creare un URL di autorizzazione speciale che invii gli utenti a un ORCID schermata di accesso. Questo URL è composto da Endpoint di autorizzazione, oltre a parametri che identificano la tua organizzazione e le autorizzazioni che desideri richiedere.
Parametro | Descrizione | Esempio |
---|---|---|
tipo_risposta | codice | |
portata | Azioni API per le quali si desidera richiedere l'autorizzazione, dall'elenco di ORCID Scopes | /persona/aggiornamento /attività/aggiornamento /limitato in lettura /autenticare |
Identificativo cliente | Il tuo cliente Membro ID (rilasciato da ORCID) | [APP-***] |
reindirizzare uri | Pagina che gli utenti vedranno dopo aver completato il processo di autorizzazione. (Per questo tutorial sarà Google OAUth Playground) | https://developers.go ogle.com/oauthplayground |
Per richiedere il permesso di aggiungere/aggiornare attività (affiliazioni, finanziamenti, lavori, peer review, risorse di ricerca) e di aggiungere/aggiornare elementi personali (altri nomi, parole chiave, paesi, URL di ricercatori, siti Web e identificatori esterni personali) e per leggere il ORCID record, l'URL di autorizzazione sarà:
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/oauthplayground
Ma possiamo utilizzare il playground di Google OAuth per aiutarci a creare l'URL di autorizzazione
- Aggiungere /activities/update, /person/update, /read-limited nel campo degli ambiti e fare clic su Autorizza API.
L'URL di autorizzazione sarebbe stato creato utilizzando le informazioni immesse nella configurazione e nei campi dell'ambito.
- An ORCID apparirà la schermata di accesso; accedi al tuo account Sandbox con l'indirizzo e-mail e la password che hai utilizzato per creare il tuo ORCID account all'inizio di questo tutorial. Una volta effettuato l'accesso, verrà visualizzata la schermata OAuth. Il nome del cliente e gli ambiti pertinenti verranno visualizzati in questa schermata. Per concedere l'accesso è necessario fare clic su 'Autorizza l'accesso'
- Dopo aver concesso l'autorizzazione, verrai reindirizzato a Google OAuth Playground poiché questo era l'URI di reindirizzamento associato alle tue credenziali Sandbox. Un codice di autorizzazione di 6 caratteri apparirà alla fine dell'URI di reindirizzamento nella barra degli indirizzi del browser (e sotto il Passo 2 sezione a sinistra della pagina in google oauth playground)
Secure https://developers.google.com/oauthplayground/code=s536Z5
Una volta che hai un codice di autorizzazione, puoi scambiarlo con un token di accesso e l'Autenticato iD dell'utente che ha eseguito l'accesso, di cui avrai bisogno per eseguire le azioni API per le quali hai richiesto l'autorizzazione.
In una situazione del mondo reale, questo scambio verrebbe eseguito dal tuo sistema, utilizzando un linguaggio di programmazione come PHP, Java o Ruby on Rails. Per questo tutorial, utilizzeremo Google OAuth Playground per simulare un'applicazione web.
- Clicchi 'Codice di autorizzazione allo scambio per i token'
Dopo aver fatto clic su "Scambia il codice di autorizzazione per i token” Il tuo token di accesso e autenticato iD apparirà nel Richiedere risposta sezione a destra. Si prega di vedere l'esempio qui sotto:
{
"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"
}
- Salva questo token!
È importante salvare il token che hai ricevuto nel passaggio precedente poiché puoi facilmente creare tutte le chiamate che devi effettuare con esso. Ti consigliamo di memorizzare la risposta di scambio di token completa
Ora hai raccolto un Authenticated ID e il permesso dell'utente di leggere il loro ORCID registrare e aggiornare il loro ORCID record.