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 e dell' migliori pratiche di integrazione. Se sei un ORCID organizzazione membro puoi contattare noi o il leader del consorzio per ricevere aiuto! .
- 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. Si prega di controllare il nostro ORCID elenco dei fornitori di servizi certificati per vedere se il tuo sistema è incluso
- 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 attorno alla tua nuova integrazione. Ti consigliamo inoltre di guardare il nostro webinar "Sono un membro e adesso?! Come parlarne ORCID'
Registrati per le credenziali sandbox e crea un test ORCID iD
Se stai creando un'integrazione personalizzata o utilizzi un'applicazione di un fornitore di servizi non certificato, ti chiediamo di utilizzare prima il nostro ambiente Sandbox per creare e testare la tua integrazione.
Puoi osservare le 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 premium 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 ORCID sistema di fornitore di servizi certificato che già supporta ORCID, non è necessario registrarsi per ottenere le credenziali API sandbox a meno che non si desideri provare il ORCID funzionalità di integrazione all'interno dell'ambiente 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 solo email 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 <a href="https://italymeetshollywood.com/wp-content/uploads/2025/02/Catalogo_GDC_2025_web.pdf">questo link</a> 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
ORCID L'API dei membri può essere utilizzata per leggere, aggiungere o aggiornare le informazioni su un utente ORCID record: devi solo richiedere il permesso ai tuoi ricercatori.
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, attività professionali, risorse di 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, cerca ORCID record o per leggere informazioni di riepilogo (solo API membro). 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.
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 di ORCID registrare per visualizzare il iD e per aggiornare correttamente. Memorizzalo insieme alle informazioni del ricercatore che vengono restituite nella risposta allo scambio di token. Il nostro consiglio è di archiviare l'URI https completo: https://orcid.org/0000-0001-5727-2427.
- Accetta e conserva persistente gettoni di accesso e dell' 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 di accesso sono validi per circa 20 anni o finché l'utente non li revoca. Ti consigliamo inoltre di conservare il ambito token, scadenza del token e dell' aggiorna i token. I token di aggiornamento possono essere utilizzati per creare nuovi token di accesso con ambiti uguali o limitati, se necessario. Memorizza i dati del token del token di accesso insieme alle informazioni del ricercatore.
- Accetta e conserva mettere i codici : ogni elemento aggiunto al file ORCID Il registro verrà restituito con un codice put dal ORCID API. Salva questo codice di inserimento a 6 cifre insieme all'elemento nel tuo sistema, in questo modo identificherai quale elemento deve essere letto, aggiornato o eliminato.
- Fornisci messaggi di errore e un contatto di supporto quando un'interazione non va come previsto.
Effettua il check-in con il ORCID team o il responsabile del consorzio per dimostrare come funziona la tua applicazione
Prima che la tua integrazione possa essere pubblicata su ORCID registro di produzione, il nostro team di coinvolgimento o il responsabile del consorzio controlleranno due volte che tutto ciò che hai creato nella sandbox funzionerà anche sulla produzione. Se stai utilizzando un ORCID Nel sistema del fornitore di servizi certificato questo passaggio può essere saltato. Abbiamo un elenco di requisiti minimi che devono essere soddisfatti prima di poter rilasciare le credenziali di produzione dell'API membro.
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/responsabile del consorzio esaminerà una demo della tua integrazione nel ORCID sabbiera. Questo ci dà la possibilità di vedere le fantastiche integrazioni che hai creato e di offrire miglioramenti al flusso di lavoro, oltre a verificare che tutte le integrazioni soddisfino le nostre migliori pratiche e i requisiti minimi per il lancio.
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.
- 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:Invia una registrazione o una serie di screenshot con descrizioni che spiegano e dimostrano chiaramente come funziona la tua integrazione in ogni passaggio, 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 potremmo vedere dall'utente, come la versione API utilizzata e il modo in cui vengono archiviati i dati
Richiesta delle organizzazioni membri ORCID Credenziali API membro sul server di produzione (live) completando il Modulo di richiesta del client API per membri di produzioneSe si utilizza un sistema di fornitori che non è presente nell'elenco di ORCID Fornitori di servizi certificati, la tua integrazione dovrà essere sottoposta a un processo di revisione per garantire che requisiti minimi per l'integrazione e best practice sono soddisfatte.
Puoi contattare il tuo Service Provider non certificato e ottenere direttamente da lui la prova che i criteri minimi sono soddisfatti. Dovrai inviare questa prova al ORCID Team di coinvolgimento o responsabile del consorzio.
Esistono diversi modi per condividere queste prove:
- Screencast o screenshot: Invia una registrazione o un set di screenshot con descrizioni che spiegano e dimostrano chiaramente come funziona la tua integrazione a ogni passaggio, incluso cosa succede se un utente nega l'accesso o disconnette il proprio iD. Assicurati di fornire ulteriore documentazione per verificare tutto ciò che non saremmo in grado di vedere dall'utente finale, come la versione API utilizzata e come vengono archiviati i dati.
- Documentazione di integrazione disponibile al pubblico: Invia un link accessibile al pubblico e aggiornato che includa una descrizione chiara di come funziona l'integrazione a ogni passaggio. Come nell'opzione 1, assicurati di fornire documentazione aggiuntiva per verificare tutto ciò che non saremmo in grado di vedere dall'utente finale, come la versione API utilizzata e come vengono archiviati i dati.
Richiedi credenziali API membro
Puoi richiedere le credenziali API per i membri una volta che la tua integrazione è stata esaminata dal ORCID team o se stai utilizzando un file ORCID sistema di fornitori di servizi certificati.
Dovrai compilare il modulo per registrare un'applicazione cliente. Di seguito una rapida panoramica dei campi richiesti:
Nome dell'organizzazione: Il tuo ORCID nome dell'organizzazione membro
Indirizzo email del contatto principale per le credenziali: Utilizzeremo questo indirizzo e-mail per inviarti le credenziali in un'e-mail crittografata e per contattarti in caso di domande o errori relativi alla tua integrazione
E-mail secondaria per la password: un indirizzo email a cui possiamo inviare la tua password email crittografata.
Nome del tuo cliente: Questo sarà il tuo ORCID nome dell'organizzazione membro. Se disponi di più di un'integrazione, aggiungeremo l'applicazione al nome.
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.
Breve descrizione della tua applicazione client: questo testo verrà visualizzato nella schermata di autorizzazione con l'icona del punto interrogativo agli utenti dell'integrazione. È richiesta una breve descrizione della tua integrazione
URI di reindirizzamento: Una volta che l'utente ha autorizzato la tua applicazione, verrà restituito a un URI da te specificato. È necessario fornire questi URI in anticipo o gli utenti dell'integrazione riscontreranno un errore.
- Sono accettati solo gli URI HTTPS.
- I domini registrati devono corrispondere esattamente ai domini utilizzati, compresi i sottodomini.
- Registra tutti gli URI di reindirizzamento completamente ove possibile.
- Sono necessari più di 5 URI di reindirizzamento? Si prega di indicarlo nelle Note per ORCID personale.
Note per ORCID risorse umane: Usa questo campo per lasciare ORCID il personale sa qualcosa in più sulla tua richiesta o sulla tua integrazione
Trasferisci la tua candidatura al ORCID Registro di produzione
Una volta ottenute le credenziali, sei pronto per rendere operativa la tua integrazione. Se desideri testare la tua integrazione prima che venga lanciata al pubblico, utilizza 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.
Se hai bisogno di aiuto, contatta il responsabile dell'impegno o il responsabile del consorzio
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.