Quando chiedi ai tuoi utenti di creare o connettere i loro ORCID iD al tuo sistema, puoi risparmiare tempo e fatica ai tuoi ricercatori inserendo le informazioni che il tuo sistema ha già memorizzato su di loro, impostando la loro lingua di visualizzazione e disconnettendoli da qualsiasi sessione attiva per assicurarti che abbiano effettuato l'accesso al ORCID conto.
Le ORCID Le API offrono diverse opzioni per personalizzare l'esperienza dell'utente
Precompila il modulo di registrazione/accessoSign
ORCID offre ai membri la possibilità di precompilare il modulo di registrazione/accesso OAuth come parte di un'interazione API utilizzando i parametri sull'URL https://orcid.org/oauth/authorize
È possibile utilizzare uno o tutti i parametri:
Parametro | Settore | Note |
nomi di battesimo | Nome di battesimo | Le nome il campo sarà compilato sul modulo di iscrizione se un indirizzo email specificato o specified ORCID iD non corrisponde a quello di un attivo ORCID record. |
nomi di famiglia | Cognome | Le cognome il campo sarà compilato sul modulo di iscrizione se l'indirizzo email specificato o specified ORCID iD non corrisponde a quello di un attivo ORCID record. |
Le e-mail/ORCID iD il campo sarà compilato sul modulo di accesso se l'indirizzo email specificato viene trovato nel nostro sistema e non è valido ORCID iD è specificato email il campo sarà compilato sul modulo di iscrizione se l'indirizzo email specificato viene trovato nel nostro sistema e non è valido ORCID iD è specificato. L'indirizzo e-mail dovrebbe essere URL codificato, inclusa la modifica di "@" in "%40".Se conosci i . dell'utente ORCID iD e indirizzo e-mail, suggeriamo esclusivamente fornendo il ORCID iD nel parametro orcid. | ||
orcida | ORCID iD | Le e-mail/ORCID iD il campo sarà compilato sul modulo di accesso se lo specificato ORCID iD si trova nel nostro sistema modulo di iscrizione altrimenti verrà visualizzato se specificato ORCID iD non si trova nel nostro sistema ORCID iD deve essere in Formato a 16 cifre del iD URI. |
Un URL di esempio con questi parametri è
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
Imposta la lingua del display
ORCID offre l'opzione di specificare la lingua di visualizzazione del modulo di registrazione/accesso OAuth come parte di un'interazione API utilizzando il parametro "lang" sull'URL https://orcid.org/oauth/authorize. Ciò imposterà anche la preferenza di visualizzazione della lingua dell'utente.
Utenti possono cambiare la lingua di visualizzazione da soli in qualsiasi momento. Sono disponibili le seguenti impostazioni della lingua:
Lingua | Code |
عربى (arabo) | ar |
čestina (ceco) | cs |
English | en |
Español (Spanish) | es |
Français (French) | fr |
Deutsch (tedesco) | de |
Italiano (italiano) | it |
日本語 (giapponese) | ja |
한국어 (coreano) | ko |
Polski (polacco) | pl |
Português (portoghese) | pt |
Русский (russo) | ru |
Türkçe (turco) | tr |
简体中文 (cinese semplificato) | zh_CN |
繁體中文 (cinese tradizionale) | zh_TW |
Esempio
Questo esempio precompila il modulo e imposta la lingua in spagnolo
https://sandbox.orcid.org/oauth/authorize?client_id=APP-NPXKK6HFN6TJ4YYI
&response_type=code
&scope=/authenticate
&redirect_uri=https%3A%2F%2Fdevelopers.google.com%2Foauthplayground
&family_names=Finn&given_names=Huckleberry&email=huck%40mailinator.com
&lang=es
Predefinito per il modulo di accesso o il modulo di registrazione
Attualmente il ORCID La schermata OAuth presenta il modulo di accesso per impostazione predefinita e fornisce un collegamento per passare al modulo di registrazione. Indipendentemente dal comportamento predefinito, il modulo visualizzato può essere impostato aggiungendo il parametro "&show_login=true" per visualizzare il modulo di accesso o "&show_login=false" per visualizzare il modulo di registrazione. Nota che se un indirizzo email o ORCID iD vengono forniti nell'URL, il modulo visualizzato sarà determinato da tali parametri e il parametro &show_login verrà ignorato.
ORCID raccomanda vivamente la best practice di consentire agli utenti finali di ridimensionare la finestra di accesso OAuth al fine di migliorare l'accessibilità, in linea con i nostri valori in materia di inclusione.
Identificare il ricercatore tramite un parametro di "stato" personalizzato
Viene utilizzato da alcune integrazioni per motivi tecnici. Non viene visualizzato nella schermata di accesso.
È possibile includere un parametro di stato con l'URL di autorizzazione per identificare l'utente, ad esempio una sequenza di numeri univoca che si traduce nell'identificatore interno dell'utente all'interno del sistema. Il parametro non influisce sull'esperienza dell'utente, ma verrà restituito con il codice di autorizzazione e potrà essere utilizzato per identificare l'utente o la sessione. Il parametro state viene restituito anche se l'utente nega l'accesso.
Si noti che il parametro state ha un limite di 2000 caratteri.
Facoltativamente, forza la disconnessione
Puoi disconnettere l'utente se sei preoccupato che ci siano più utenti su una singola macchina.
Se sei preoccupato che più utenti si trovino sulla stessa macchina e non si disconnettono tra le sessioni, puoi forzarli a riautenticarsi durante il processo OAuth. Includi semplicemente prompt=login
nella richiesta OAuth. Puoi anche impostare un max_age in secondi per costringere gli utenti a riautenticarsi se la loro sessione supera una certa durata. Guarda il nostro Documentazione OpenID Connect per ulteriori dettagli.
Saltare l'autorizzazione
ORCID salta l'autorizzazione in determinate circostanze.
Se esiste già un token di accesso attivo con gli stessi ambiti richiesti dall'URL di autorizzazione OAuth e l'utente ha eseguito l'accesso al proprio ORCID record, non verrà loro richiesto di concedere nuovamente l'autorizzazione. Verranno invece indirizzati direttamente all'URI di reindirizzamento. Se vuoi richiedere a un utente di concedere l'autorizzazione ogni volta che si connette, usa il pulsante metodo di disconnessione forzata