ORCID offre diverse API che consentono ai tuoi sistemi di connettersi al ORCID registro, compresa la lettura e la scrittura su ORCID record. Alcune funzioni API sono disponibili gratuitamente per chiunque (API pubblica); altri sono disponibili solo per ORCID organizzazioni aderenti (API per membri e membri premium). Chiunque è libero di testare le nostre API sul nostro server di test sandbox.
Prima che inizi
All'inizio della pianificazione dell'integrazione, dovresti considerare:
- Cosa vuoi fare con il ORCID API— visita il nostro flussi di lavoro.
- Che sia la tua organizzazione già un ORCID membro o è pianificando di diventarlo. Solo ORCID i membri possono aggiungere elementi a ORCID Records.
- Sia che tu stia utilizzando un sistema che già supporta ORCID. Se lo sei, potrebbe essere semplice come configurare il tuo sistema con cui lavorare ORCID.
- Come comunicherai con i tuoi ricercatori sui cambiamenti in corso di attuazione, di cosa avrai bisogno da loro, i vantaggi per loro e cosa dovranno fare. Visita il nostro Risorse di sensibilizzazione pagina per idee su come costruire una campagna di comunicazione intorno alla tua nuova integrazione.
Registrati per le credenziali sandbox e crea un test ORCID iD
Ti chiediamo di creare prima strumenti che interagiscono con , il ORCID sandbox per evitare di influenzare i dati sul registro di produzione durante i test o sui propri sistemi.
Puoi richiedi le credenziali dell'API membro sandbox per creare e testare la tua applicazione. Queste credenziali ti consentono di effettuare chiamate all'API del membro sandbox per leggere, scrivere e aggiornare ORCID record. L'accesso all'ambiente di test sandbox è disponibile gratuitamente per chiunque, anche se non sei un ORCID organizzazione membro.
Note:: Se stai utilizzando un sistema di terze parti che già supporta ORCID, potrebbe non essere necessario registrarsi per le credenziali dell'API sandbox.
La sandbox ti consente di creare account utente di prova e sviluppare la tua integrazione senza doversi preoccupare di influenzare i dati sul live (produzione) ORCID Registro. La sandbox si comporta allo stesso modo della produzione ORCID Registro con alcune eccezioni.
Creazione di un account di prova
Per testare il ORCID API e chiamate API, come la lettura e l'aggiunta di informazioni a un file ORCID record, dovrai anche creare un test ORCID registrare nella sandbox. Questo può essere fatto tramite l'interfaccia utente, proprio come nella produzione ORCID Registro. Vai a https://sandbox.orcid.org/register e registrati per un account.
Indirizzi di posta elettronica
Il server sandbox invia e-mail di notifica solo a Mailinator (@mailinator.com) indirizzi e-mail per non inviare spam ai server di posta involontariamente. Non riceverai un'e-mail di verifica o una notifica di reimpostazione della password a meno che tu non utilizzi un indirizzo @mailinator.com e la verifica è necessaria per apportare modifiche manuali ai record sandbox. Scopri di più sulle loro caselle di posta pubbliche gratuite Se non si desidera utilizzare a Mailinator indirizzo, quindi prendi nota del tuo nome utente e password (poiché li utilizzerai per concedere l'autorizzazione alla tua applicazione durante il test) e contattaci per richiedere assistenza con la verifica.
Mailinator è un servizio di posta elettronica che ha un servizio pubblico gratuito e un servizio privato a pagamento. Per i test è possibile utilizzare il servizio pubblico completamente gratuito. Scopri di più sui loro livelli qui.
Mailinator è un servizio di terze parti che non è gestito o mantenuto da ORCID. Ti consigliamo di rivedere il funzionamento di questo servizio e le sue limitazioni prima di utilizzare questi indirizzi.
Determina le autorizzazioni utente di cui avrai bisogno
La ORCID L'API dei membri può essere utilizzata per leggere, aggiungere o aggiornare le informazioni su un utente ORCID record: devi solo richiedere l'autorizzazione ai tuoi ricercatori. Gli ambiti di cui hai bisogno influenzeranno in gran parte quale API si adatta meglio al tuo sistema.
Quando si richiede il permesso di interagire con an ORCID record dell'utente, si specifica uno o più 'scope'. Ciascun ambito consente di eseguire determinate operazioni, ad esempio leggere il record o aggiornare una determinata sezione.
3 gambe si riferisce ai tre attori coinvolti nell'ottenere il permesso da un utente; ORCID, il tuo sistema e l'utente stesso.
/autenticare 
Questo ambito viene utilizzato per raccogliere i ORCID iD e leggere le informazioni pubbliche solo sul record. Tutti gli altri ambiti a 3 vie includono l'autorizzazione di autenticazione, quindi questo ambito può essere omesso se si richiede qualsiasi altro accesso. Questo ambito è disponibile nell'API Membro o Pubblica.
/read-limited (solo API membro) 
Questo ambito viene utilizzato per ottenere l'accesso alla lettura di elementi pubblici e a visibilità limitata su un ORCID disco. Questo ambito è disponibile solo sull'API membro.
/activities/update (solo API per i membri) 
Questo ambito viene utilizzato per scrivere, aggiornare ed eliminare elementi nelle sezioni di affiliazione, finanziamento, lavori e ricerca e revisione paritaria di un ORCID disco. Questo ambito è disponibile solo sull'API membro.
/person/update (solo API per i membri)
Questo ambito viene utilizzato per scrivere, aggiornare ed eliminare elementi nelle sezioni di altri nomi, parole chiave, paesi, URL dei ricercatori, siti Web e identificatori esterni personali del record. Questo ambito è disponibile solo sull'API membro.
OpenID
Questo ambito viene utilizzato dagli integratori OpenID quando è richiesto un id_token. Quando l'ambito openid è incluso, il registro restituirà un id_token all'interno della risposta del token e concederà al client l'autorizzazione per accedere all'endpoint delle informazioni utente per quell'utente. Questo ambito è disponibile nell'API pubblica e membro.
Si prega di notare che l'ambito 'openid' non inizia con una '/' come l'altro ORCID Ambiti API. Questo perché l'ambito 'openid' non è definito da ORCID, ma invece definito dalla specifica OpenID Connect. Si prega di consultare il nostro Documentazione OpenID per maggiori informazioni.
Scopi multipli Multiple
È possibile richiedere più ambiti in una singola interazione elencando gli ambiti nell'URL di autenticazione con uno spazio codificato tra ciascuno, ad esempio scope=/read-limited%20/activities/update%20/person/update
Accesso completo
Se desideri l'accesso completo per leggere e modificare un record, includi tre ambiti nell'URL di autenticazione: /read-limited, /activities/update e /person/update. Nell'URL apparirebbero come scope=/read-limited%20/activities/update%20/person/update
Ambiti a 2 vie (credenziali client)
Per alcune attività non è necessario chiedere il permesso all'utente. Gli ambiti OAuth a due vie sono richiesti direttamente dal ORCID API e non richiedono al ricercatore di concedere l'autorizzazione. I token con questi ambiti sono validi per 20 anni e possono essere riutilizzati
/leggi-pubblico
Questo ambito viene utilizzato per leggere le informazioni pubbliche su un singolo ORCID iD o cercare ORCID record. Questo ambito è disponibile nell'API Membro o Pubblica.
/ webhook
Questo ambito consente a un'applicazione client di registrare un webhook su un ORCID record, per ricevere notifiche quando un record viene aggiornato. Questo ambito è disponibile per premium ORCID solo i membri. Se non sei un membro premium, ma desideri testare questa funzione nella sandbox dello sviluppatore, per favore contatti ORCID Community.
- Nel passato ORCID supportato altri ambiti, che ora sono stati eliminato gradualmente.
- Puoi scoprirlo quali ambiti sono necessari per aggiungere o aggiornare una particolare sezione qui.
Assicurati di poter archiviare i dati in modo sicuro
È importante che il tuo sistema sia in grado di memorizzare le informazioni in modo sicuro.
Le integrazioni devono memorizzare più di un semplice ORCID record. Il tuo sistema dovrà essere in grado di:
- Accetta e conserva ORCID iD: il tuo sistema dovrà conoscere il iD della ORCID registrare da aggiornare. Memorizzalo insieme alle informazioni del ricercatore. Il nostro consiglio è di memorizzare l'intero https URI: https://orcid.org/0000-0001-5727-2427.
- Accetta e conserva persistente gettoni di accesso o aggiorna i token: i token di accesso possono essere utilizzati per leggere e aggiornare i record, nonché per indicare che il iD è stato autenticato. I token persistenti sono validi per circa 20 anni o finché l'utente non li revoca. I token di aggiornamento possono essere usati per creare nuovi token di accesso con ambiti uguali o limitati. Conserva i token insieme alle informazioni del ricercatore. Ti consigliamo inoltre di conservare il file ambito token, e il,scadenza del token.
- Accetta e conserva mettere i codici (se si aggiorna ORCID record): ogni elemento che aggiungi a ORCID Il registro verrà restituito con un codice put dal ORCID API. Salva questo codice put insieme all'elemento nel tuo sistema, è così che identificherai quale elemento deve essere letto o aggiornato.
- Registra le interazioni: il tuo sistema dovrebbe registrare entrambe le chiamate effettuate al ORCID API e risposte ricevute. Questo è necessario quindi ORCID può aiutare se un problema si sviluppa in seguito.
- Fornisci messaggi di errore e un contatto di supporto quando un'interazione non va come previsto.
Effettua il check-in con il ORCID team per dimostrare come funziona la tua applicazione
Prima che la tua integrazione possa essere pubblicata su ORCID registro di produzione, il nostro Engagement Team verificherà che tutto ciò che hai costruito sulla sandbox funzionerà anche in produzione. Se stai usando un sistema con built-in ORCID supporto, questo passaggio potrebbe essere saltato.
Richiesta delle organizzazioni membri ORCID Credenziali API membro sul server di produzione (live) completando il Modulo di richiesta del client API per membri di produzione. Prima di emettere le credenziali API del membro di produzione, il ORCID Il team di coinvolgimento esaminerà una demo della tua integrazione nel ORCID sabbiera. Questo ci dà la possibilità di vedere le grandi integrazioni che hai creato e offrire miglioramenti del flusso di lavoro, oltre a verificare che tutte le integrazioni soddisfino le nostre migliori pratiche.
Per fornire una demo del tuo sistema dovrai impostare un'integrazione funzionante con il ORCID sandbox che il ORCID squadra può visualizzare in anteprima. Esistono alcuni modi per condividere la tua integrazione sandbox funzionante:
- Consigliato: Dimostrazione dal vivo: Contattaci per programmare una dimostrazione dal vivo. Forniremo un software per riunioni che ti consentirà di condividere lo schermo per dimostrare la tua integrazione. Questo ci dà anche l'opportunità di saperne di più su come funziona il tuo sistema e su come stai spiegando i vantaggi del tuo ORCID integrazione, in modo da poter fornire un supporto migliore per te e i tuoi utenti.
- Sito di prova: Se il tuo sito di sviluppo è pubblico, inviaci l'URL insieme alle credenziali di prova (se necessarie) per accedere al tuo sistema e istruzioni che descrivono come utilizzare il tuo sistema ORCID Caratteristiche. Fornisci ulteriore documentazione per verificare ciò che non saremmo in grado di vedere dal lato utente, ad esempio la versione API utilizzata, quali dati sono archiviati dal tuo sistema, ecc.
- Screencast o screenshot (consigliato per ORCID-sistemi abilitati che richiedono una dimostrazione): Invia una registrazione o una serie di screenshot con descrizioni che spiegano e dimostrano chiaramente come funziona la tua integrazione in ogni fase, incluso cosa succede se un utente nega l'accesso o disconnette il proprio iD. Assicurati di fornire documentazione aggiuntiva per verificare tutto ciò che non saremmo in grado di vedere dal lato utente, come la versione dell'API utilizzata e il modo in cui i dati vengono archiviati.¬¨‚
Se stai usando uno dei ORCID-sistemi abilitati che non richiedono una dimostrazione, è possibile direttamente richiedi le credenziali dell'API del membro di produzione. Assicurati di specificare quale sistema (e, se applicabile, versione) stai utilizzando nelle note.
Ci sono una serie di requisiti che ci aspettiamo che tutte le integrazioni dei membri soddisfino. Il ORCID il team assicurerà che questi requisiti siano stati soddisfatti come parte del processo di revisione dell'integrazione.
- Usa il OAuth autenticare ORCID iD (non consentire agli utenti di cercare o digitare ORCID ID.)
- Includi un ORCID pulsante o collegamento con marchio sul tuo sito per avviare l'autenticazione dell'iD.
- Presentare la schermata di autorizzazione OAuth secondo il nostro linee guida
- Usa HTTPS per gli URI di reindirizzamento del tuo sito e via ORCID Chiamate API
- Accetta e archivia tutti i dati restituiti nello scambio di token insieme ai dati dell'utente nel tuo sistema
- Usa appropriato ambiti o metodi di richiesta (es. chiamate POST per aggiungere nuove informazioni e chiamate PUT per aggiornare le informazioni esistenti)
- Mostra pubblicamente l'autenticato ORCID ID. Gli iD dovrebbero essere visualizzati dopo il nostro marchio e iD visualizzare le linee guida.
Richiedi le credenziali sul server di produzione
Puoi richiedere le credenziali API per i membri una volta che la tua integrazione è stata esaminata dal ORCID team o se stai utilizzando un sistema di provider di servizi che ha un integrato ORCID integrazione.
Dovrai compilare il modulo per registrare un'applicazione cliente. Di seguito una rapida panoramica dei campi richiesti:
Note per ORCID personale: Usa questo campo per lasciare ORCID sapere se stai utilizzando un sistema di fornitori, le integrazioni sono state riviste ecc.
Indirizzo e-mail: Invieremo le credenziali a questo indirizzo. Questo dovrebbe essere il contatto con cui abbiamo lavorato sull'integrazione o il contatto tecnico che teniamo per la tua organizzazione.
Contatto per la ricezione del PIN per l'accesso alle credenziali: Ti inviamo le credenziali complete in modo sicuro. Invieremo un passcode per accedere alle tue credenziali API a questo contatto. Questo deve essere un contatto diverso dal contatto precedente elencato.
Breve descrizione della tua applicazione client: questo testo verrà visualizzato nella schermata di autorizzazione con l'icona del punto interrogativo per gli utenti dell'integrazione. È richiesta una breve descrizione dell'integrazione.
URL della home page della tua applicazione: Visualizzato come collegamento nell'elenco delle organizzazioni attendibili all'interno degli utenti ORCID pagina delle parti fidate. Questo dovrebbe essere un collegamento alla tua organizzazione o alla pagina principale della tua domanda.
URI di reindirizzamento OAuth2 o URL di callback per il client: URL consentiti nella tua applicazione web a cui verranno reindirizzati gli utenti dopo che avranno autorizzato l'accesso al loro ORCID registrare i dati. Tutti gli URI di reindirizzamento devono essere HTTPS per i client server di produzione (live).
Una volta effettuata la richiesta, viene eseguita una procedura manuale per l'emissione delle credenziali e riceverai un'e-mail con il tuo cliente iD e segreto del cliente. In genere queste richieste vengono elaborate in meno di 48 ore.
Trasferisci la tua candidatura al ORCID Registro di produzione
Una volta che hai le tue credenziali, sei pronto per portarlo in diretta. Se desideri testare la tua integrazione prima che venga lanciata al pubblico, usa quella del tester ORCID record o di un collega ORCID record.
Lancia e fallo sapere a tutti
L'attivazione di un'applicazione non è l'ultimo passaggio: devi continuare a comunicare con i tuoi utenti in modo che sappiano come connettere i loro ORCID iD al tuo sistema in modo rapido e semplice. Le integrazioni efficaci contengono sia una componente tecnica (trattata da questa guida) sia una componente sociale. I ricercatori devono essere informati su cosa ORCID è, perché stai richiedendo l'accesso al loro ORCID record e cosa farai con i loro dati.
- Crea una tempistica di comunicazione: assicurati che le parti interessate siano a conoscenza del tuo ORCID progetto ben prima del lancio.
- Usa una combinazione di comunicazioni top-down e bottom-up.
- Promuovi il tuo ORCID integrazione spesso e a diversi tipi di pubblico.
- Crea risorse locali per supportare i tuoi utenti, come FAQ, libguide, pagine web, tutorial e video.
- Nominare un referente locale per ORCID-domande correlate.
A supporto della componente social offriamo un toolkit di Risorse di sensibilizzazione per aiutarti a sviluppare una campagna per supportare la tua integrazione e comunicare ai tuoi ricercatori:
- Che ORCID è.
- Perché il tuo sistema raccoglie iD e come il tuo sistema eseguirà le attività, come l'aggiornamento dei propri record.
- Perché i tuoi ricercatori trarranno vantaggio dalla creazione di un ORCID iD e collegando i loro iD al tuo sistema.
- Come ORCID avvantaggia la più ampia comunità di ricerca globale.
Costruiremo continuamente questa "biblioteca" di risorse in base al feedback della comunità. Se hai un'idea per qualcosa che ti piacerebbe vedere, non esitare a contattarci.