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 membri (Member e Premium Member API).
Chiunque è libero di testare l'API sul nostro server di test sandbox e incoraggiamo tutte le organizzazioni che utilizzano ORCID – soci e non soci – per entrare a far parte del nostro Gruppo utenti API, dove è possibile porre domande e conoscere i nuovi sviluppi tecnici.
Cerca le FAQ qui:
Le basi
Gli elementi (lavori, occupazione, finanziamenti, revisione paritaria, ecc.) possono essere aggiunti a un ORCID registrare utilizzando il ORCID API membro. Avrai bisogno di quanto segue:
- Il permesso dei ricercatori
- Credenziali API dei membri
- E nemmeno:
- Un sistema di fornitori che si integra con il ORCID API membro
- Il tuo sistema che si integra con il ORCID API membro
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.
Raccogli ID autenticati quando chiedi a un ricercatore di accedere con il suo ORCID ID. Questo processo utilizza una tecnologia chiamata "OAuth" o "SSO" e dovrebbe essere integrato nel flusso di lavoro.
Guarda l'esercitazione sull'API 'Ottieni un file autenticato ORCID iD' per ulteriori dettagli.
Il processo per ottenere il permesso di aggiungere o aggiornare i dati su un utente ORCID record utilizza OAuth, come descritto nella nostra Domande frequenti su OAuth a 3 vie. Solo ORCID i membri possono utilizzare l'API dei membri per richiedere le autorizzazioni di aggiornamento. In parole povere funziona così:
- Il tuo sistema locale crea un collegamento speciale
- Quando si fa clic, l'utente viene inviato a ORCID, effettua l'accesso e concede l'autorizzazione
- ORCID rimanda l'utente al tuo sistema con un 'codice di autorizzazione'
- Il tuo sistema scambia quel codice con un "token di accesso"
- Il token di accesso consente di aggiornare il record dell'utente
Raccolta convalidata ORCID Ids per gli individui attraverso il processo OAUTH è importante. Gli individui accedono al loro ORCID account utilizzando l'indirizzo e-mail e la password registrati oppure possono creare un nuovo account e quindi autorizzare il sistema a ottenere il loro ORCID ID. Questo ti assicura di ottenere il corretto ORCID iD per il ricercatore e che le informazioni su quel record riflettano le sue attività di ricerca (cfr Cosa c'è di così speciale nel firmare I).¬¨‚
Puoi contribuire a semplificare la vita ai tuoi utenti collegando le informazioni convalidate ai loro ORCID record. Contribuirai anche a creare fiducia nelle comunicazioni accademiche e, mantenendo tali dati aggiornati, potrai ridurre l'onere di segnalazione per i tuoi utenti e migliorare la qualità dei dati.
ORCID per gli Enti di Ricerca
Oltre al suo utilizzo come identificatore persistente per i tuoi ricercatori, ORCID può aiutarti ad assumere il controllo di come il nome della tua istituzione viene utilizzato nei sistemi di ricerca. In combinazione con altri identificatori persistenti ORCID ti consente di affermare in modo autorevole il tuo personale, i docenti e le affiliazioni degli studenti con il tuo istituto. Puoi anche usare ORCID API per ricevere notifiche in tempo reale sulle attività di ricerca, per aggiornare automaticamente i moduli e per seguire le carriere dei tuoi alunni.
ORCID per le organizzazioni di finanziamento
Incorporando ORCID iD nei tuoi flussi di lavoro di finanziamento, puoi collegare in modo affidabile i tuoi beneficiari e i programmi di finanziamento e risparmiare tempo a tutti e ridurre gli errori causati dalla digitazione manuale delle informazioni. Usando ORCID nei tuoi sistemi, puoi svolgere la tua parte nella costruzione di un'infrastruttura di informazioni di ricerca affidabile affermando le connessioni tra gli individui e le sovvenzioni che assegni loro.
ORCID per gli editori
I ricercatori sono al centro di tutto ciò che fanno gli editori accademici e di ricerca. Informazioni accurate su autori e revisori sono fondamentali per l'indicizzazione, la ricerca e la scoperta, il monitoraggio delle pubblicazioni, l'attribuzione dei finanziamenti e dell'utilizzo delle risorse e il supporto della revisione tra pari.
ORCID funge da hub di informazioni, consentendo ai tuoi autori e revisori di connettersi in modo affidabile ai loro contributi e di condividere informazioni dai loro ORCID registra mentre interagiscono con i tuoi sistemi di pubblicazione. La raccolta di ID per tutti i tuoi autori e revisori durante il processo di pubblicazione, che si tratti di libri, riviste, set di dati, composizioni, presentazioni, codice o una varietà di altri lavori, consente di condividere facilmente le informazioni, garantisce che i ricercatori possano fornire il consenso alla condivisione, fa risparmiare tempo e fatica ai ricercatori, riduce il rischio di errori e, soprattutto, consente ai ricercatori di ottenere il credito che meritano per l'importante lavoro che stanno svolgendo.
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.
integrazione
Le credenziali del cliente pubblico sono concesse a individui e non a organizzazioni. Le credenziali non possono essere trasferite da un individuo all'altro, ma possono essere convertite in credenziali API membro se si riceve un accordo da tutte le parti e l'organizzazione è un membro attivo di ORCID.
Spostamento del cliente ID alla Member API non altererà il Client ID, solo il Client Secret, e manterrai il numero di iD connessi con il tuo permesso di sola lettura.
Quando si converte il client API pubblico in un client API membro, il file Termini di servizio del cliente pubblico non si applicano più e sono sostituiti dai termini del Member Agreement.
Per il trasferimento avremmo bisogno di:
- Conferma del client API pubblico ID da convertire.
- Che sia il contatto principale dell'organizzazione e il detentore del record dell'attuale cliente dell'API pubblica ID accettare la modifica dei Termini di servizio. (Il detentore del record deve essere un dipendente, appaltatore o funzionario dell'organizzazione membro) Terremo un registro del consenso di entrambe le parti.
- Una data/ora in cui deve avvenire la migrazione. Come parte di questa migrazione, aggiorneremo il client ID e inviarti un nuovo segreto client in un'e-mail crittografata. Tieni presente che una volta aggiornato il client, la tua integrazione non funzionerà fino a quando non aggiornerai il client secret. Per questo occorre fissare una data e un orario per farlo e per evitare disagi per gli utenti.
Per completare la conversione, dovrai aggiornare:
- Dal vecchio segreto client al nuovo segreto client.
- L'host dell'API da pub.orcid.org a apiorcid.org.
Con l'ID client API membro convertito, puoi aggiornare gli ambiti da aggiungere ambiti dell'API membro. Ciò richiederà l'autorizzazione degli utenti e verranno generati nuovi token di accesso per includere i nuovi ambiti/autorizzazioni.
Tieni presente che non siamo in grado di convertire le credenziali dei client API membri in credenziali API pubbliche.
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.
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.
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.
Consigliamo agli sviluppatori di testare l'API pubblica nel server di test sandbox prima di utilizzare la versione di produzione. Di seguito sono riportati i passaggi su come registrarsi per le credenziali API pubbliche sia nell'ambiente Sandbox che in quello di produzione.
- Accedi al tuo ORCID disco:
Server di produzione: https://orcid.org/signin
Server di test sandbox: https://sandbox.orcid.org/signin - Clicca sul tuo nome nell'angolo in alto a destra
- Clicchi Strumenti di sviluppo dall'opzione di menu
Nota: Per accedere agli Strumenti per sviluppatori, devi verificare il tuo indirizzo email. Se non hai ancora verificato il tuo indirizzo email, ti verrà chiesto di farlo prima di poterti registrare per le credenziali API pubbliche - Leggi e accetta il 'ORCID Termini di servizio del cliente pubblico
- Fai clic su "Registrati per ORCID credenziali API pubbliche”.

Completamento del modulo dei dettagli dell'applicazione
- Dopo esserti registrato per le tue credenziali API pubbliche, verrai reindirizzato a Strumenti per sviluppatori (https://orcid.org/developer-tools or https://sandbox.orcid.org/developer-tools).
- È necessario completare il modulo dei dettagli della domanda presentato per registrare una nuova domanda.
- Nome: il nome della tua applicazione. Questo verrà mostrato agli utenti quando concedono alla tua applicazione l'autorizzazione per ottenere il loro ORCID iD, e verrà visualizzato nella loro Elenco delle organizzazioni affidabili. Ti consigliamo di utilizzare il nome della tua organizzazione o servizio (ad es. il nome di una rivista).
- URL dell'applicazione: Il sito web che l'utente può visitare per saperne di più sulla tua applicazione. Questo verrà visualizzato anche nel loro Elenco delle organizzazioni affidabili.
- Descrizione dell'applicazione: Informazioni sull'applicazione che stai sviluppando e su come utilizzerai le ORCID ID. Questo verrà mostrato agli utenti nella schermata OAuth.

Aggiunta 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.
- Inserisci il tuo URI di reindirizzamento nella casella fornita
- Se devi inserire più di un URI di reindirizzamento, fai clic su "Aggiungi un altro URI di reindirizzamento"
Nota bene:
- Solo URI HTTPS sono accettati in produzione
- Domini registrati MUST corrispondono esattamente ai domini utilizzati, compresi i sottodomini
- Registra tutti gli URI di reindirizzamento completamente ove possibile. Questa è l'opzione più sicura e ciò che consigliamo. Per ulteriori informazioni sugli URI di reindirizzamento, consultare il nostro Domande frequenti sull'URI di reindirizzamento
Salvataggio della tua applicazione
Dopo aver completato il modulo di domanda e aver aggiunto i tuoi URI di reindirizzamento, puoi salvare la tua domanda.
- Fai clic su "Salva la mia applicazione e genera il mio cliente". ID e segreto'
Verrai reindirizzato alla pagina degli strumenti per sviluppatori che ora includerà le tue credenziali del client API pubblica

Aggiornamento delle tue credenziali
Apportare una modifica alle informazioni sulla tua domanda è molto semplice.
- Modifica le informazioni pertinenti e fai clic su "Salva domanda"
Usa le tue credenziali
Ora che hai le tue credenziali, è ora di iniziare a utilizzare il ORCID API pubblica!
Tieni presente che possiamo trasferire le tue credenziali all'API dei membri se diventi un ORCID membro in futuro.
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.
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.
Ricerca e collegamento guidati sono integrazioni che possono essere utilizzate per importare elementi (principalmente opere) nel ORCID Registro. Devono essere sottoposti a test tra l'integratore e ORCID prima che possano essere rilasciati nell'ambiente del registro di produzione.
A seconda delle risposte alle domande seguenti, la tua integrazione potrebbe essere un candidato adatto per la ricerca e il collegamento: contattaci per discuterne ulteriormente prima di iniziare a sviluppare una procedura guidata di ricerca e collegamento:
- Qual è il pubblico di destinazione della procedura guidata? Ad esempio, autori, revisori o candidati a borse di studio a livello nazionale, disciplinare o globale
- All'incirca quanto è grande il pubblico previsto?
- Servirà una popolazione attualmente sottoservita dai maghi esistenti? Ad esempio, contributi di ricerca in una lingua o disciplina specifica, o che sono di tipo nuovo
- Come garantirete che la procedura guidata offra una buona esperienza utente?
- Quale supporto utente fornirete?
- C'è - o ci sarà - e ORCID persona di riferimento della tua organizzazione, ad esempio un product manager, per la procedura guidata?
- Come farai ad assicurarti che? ORCID gli iD sono autenticati?
- Ingerisci e visualizzi, o lo farai? ORCID iD sulla tua piattaforma?
- La ricerca della tua piattaforma è abilitata da iDs?
Si prega di consultare il nostro Flusso di lavoro di ricerca e collegamento per ulteriori dettagli.
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.
I webhook consentono ai membri premium di "guardare" ORCID registra ed essere informato di eventuali modifiche.
Utilizzando l'API e le credenziali client dei membri premium, i membri premium possono registrare un URL di richiamata per ogni autenticato ORCID iD che desiderano monitorare. Il ORCID il titolare del record non deve concedere all'organizzazione l'autorizzazione specifica per registrare l'URL, ma l'effettivo scambio di dati si basa sui livelli di privacy stabiliti dal ORCID iD titolare.
Con questo a posto ORCID notificherà l'URL specificato inviando una richiesta quando ci sono modifiche al ORCID record.
Metadati
Tutte le sezioni di affiliazione utilizzano lo stesso set di metadati nell'API:
- Nome dell'organizzazione:* Il nome dell'organizzazione al livello più alto (ad es. "Boston University" anziché "Boston University School of Medicine").
- Città dell'organizzazione:* Città in cui ha sede l'organizzazione.
- Regione dell'organizzazione: Regione in cui ha sede l'organizzazione.
- Paese dell'organizzazione* il paese dell'organizzazione. Questo dovrebbe essere popolato con il codice paese a due lettere ISO 3166 Alpha-2.
- Organizzazione ID (ROR, GRID, Ringgold** o LEI):* Un identificatore univoco per l'organizzazione e la sua fonte. Raccomandiamo che l'organizzazione madre ID viene utilizzato all'interno dell'affiliazione e non della divisione o del dipartimento.
- Ruolo/Titolo: La posizione ricoperta, o il titolo di studio conseguito o da conseguire.
- Dipartimento: Qualsiasi suddivisione dell'organizzazione madre.
- URL: Un URL a una risorsa sull'affiliazione
- Data d'inizio: La data di inizio del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno).
- Data di fine: La data di fine del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno)
- Un identificatore persistente esterno che descrive l'affiliazione: Un identificatore univoco per l'effettiva asserzione di affiliazione
*Indica un campo richiesto.
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
Ci sono un certo numero di sezioni sotto la parte biografica di an ORCID disco:
Conosciuto anche come: Ciò può includere un nome abbreviato, varianti che includono le iniziali di uno o più nomi, secondi nomi, nomi precedenti o alternativi o nomi in un set di caratteri diverso. Ogni nome deve essere aggiunto come un singolo elemento. Questo è un campo di testo libero fino a 255 caratteri.
Siti internet: Questa sezione include una descrizione (facoltativa) e un URL del sito Web (obbligatorio)
Paese: La sezione Paese di an ORCID record consente ai ricercatori e alle organizzazioni membri di aggiungere uno o più paesi in cui conducono ricerche o che sono l'argomento della loro ricerca. Gli elementi nell'elenco dei paesi provengono da ISO 3166, lo standard internazionale per i codici di paesi e regioni.
Identificatori esterni (altri ID): Questa sezione può essere aggiunta solo dalle organizzazioni membri. Si prega di notare che, sebbene molte organizzazioni raccolgano altri identificatori esterni per i propri ricercatori, ad esempio gli ID autore di Scopus, solo l'emittente di tali identificatori può affermarli in modo autorevole. Pertanto, raccomandiamo vivamente che la tua organizzazione aggiunga solo identificatori che il tuo sistema ha creato e utilizza per identificare i ricercatori. Questa sezione comprende quattro componenti (* indica un campo obbligatorio):
- tipo di documento d'identità*
- Valore ID*
- relazione d'identità*
- URL ID
- Titolo:* Il titolo dell'opera
- Sottotitolo: Un sottotitolo all'opera
- Titolo tradotto: Il titolo con cui l'opera appare in un'altra lingua, la lingua del titolo tradotto è registrata come attributo
- Titolo della rivista: Il nome di una raccolta più ampia a cui appartiene l'opera, ad esempio una rivista per articoli di riviste o un libro per capitoli di libri. Anche se questo è etichettato come titolo della rivista, può essere usato per altri lavori
- Breve descrizione: Una breve descrizione o un riassunto dell'opera
- Tipo di citazione: Il formato in cui è fornita la citazione. Questo campo è selezionato da un elenco contenente i seguenti valori: APA, BIBTEX, CHICAGO, HARVARD, IEEE, MLA, RIS, UNSPECIFIED, VANCOUVER
- Citazione-valore: Il contenuto della citazione
- Tipo di lavoro: Il tipo di oggetto l'opera è. Questo campo deve essere selezionato dal tipi di lavoro supportati
- Data di pubblicazione: La data di pubblicazione dell'opera. Si consiglia di utilizzare la prima data di pubblicazione
- Tipo-id esterno:* Il tipo di identificatore. Questo campo deve essere selezionato dal identificatori di lavoro supportati
- Valore-id esterno:* L'identificatore stesso
- URL-id-esterno: Un URL in cui l'identificatore risolve
- Relazione-id-esterna:* Gli identificatori che si applicano solo al lavoro da aggiungere verrebbero contrassegnati come Self. Gli identificatori che si applicano a una raccolta più ampia a cui appartiene questo lavoro sarebbero impostati su Part-of. Gli identificatori che si applicano alle versioni alternative del lavoro verrebbero impostati su version-of. Gli identificatori che si applicano al finanziamento per il lavoro sarebbero impostati su finanziato da.
- URL di lavoro: Un URL che collega al lavoro
- Collaboratori al lavoro: Informazioni sulle persone che hanno creato l'opera
- Codice lingua: Il linguaggio utilizzato per descrivere l'opera nei campi precedenti
- Paese: Un paese in cui l'opera è stata pubblicata o associata in altro modo
* Indica campo obbligatorio required
Esistono molti tipi di risorse di ricerca, dai reagenti monouso alle collaborazioni internazionali con strutture dedicate. ORCID supporta un modello di alto livello che può collegarsi ad altri luoghi per dettagli specifici del dominio.
Esistono quattro tipi di risorse di alto livello:
Tipo di risorsa | Definizione | Esempi |
Infrastruttura | Una struttura, un edificio o un altro spazio fisico utilizzato per eseguire ricerche | Sorgente di spallazione di neutroni, struttura per animali, enclave di dati, sito archeologico, array di telescopi. navi, aerei, fattorie, laboratori |
Collezione | Un oggetto o un gruppo di oggetti utilizzati per scopi di ricerca; può essere tangibile o digitale | Missione oceanica, campagna sul campo, set di dati o risorse collaborative, raccolta di libri rari; collezione museale, collezione di campioni biologici |
Materiale | Hardware utilizzato per scopi di ricerca | Microscopio, computer, vetreria, campioni, materiali |
Servizi | Servizi utilizzati per scopi di ricerca | Analisi proteomica, servizi informatici, analisi di dati, supporto logistico, servizi legali, editing di testi, consulenza di esperti o di personale |
Oltre al tipo di risorsa, un elemento risorsa di ricerca all'interno di un ORCID record contiene le seguenti informazioni. * indica gli elementi richiesti
- Titolo Proposta/Registrazione:* Questo è il campo di visualizzazione principale per le risorse di ricerca, ad esempio "Neutron Beam Award" o "Beam time and computing resources"
- ID Proposta/Registrazione:* Questo è l'identificatore pubblico (DOI, PURL, ecc.) per la proposta o richiesta di utilizzo della risorsa. Idealmente, questo identificatore dovrebbe essere persistente e risolversi in una pagina di destinazione pubblica con informazioni sulla proposta o richiesta, come un database dei premi o un registro utente delle risorse.
- Host della proposta:* Questa è l'organizzazione che riceve ed elabora proposte o richieste di risorse. L'host della proposta può essere lo stesso dell'host delle risorse
- ID organizzazione ospitante proposta* Questo è l'identificatore pubblico (uno tra ROR, GRID, Open Funder ID, LEI) per l'organizzazione che gestisce la proposta o il processo di richiesta
- Risorse:* (fino a 100)
- Nome risorsa:* – ad es., “Fonte di spallazione di neutroni”
- ID risorsa:* – da un elenco estensibile di tipi PID accettabili (es. RRID, DOI, URI)
- Tipo di risorsa:* – uno tra 'Infrastrutture', 'Collezioni', 'Attrezzature' o 'Servizi'
- Host risorse:* Questa è l'organizzazione che amministra o gestisce la Risorsa, come un laboratorio nazionale, un'agenzia governativa o un'università di ricerca
- ID organizzazione host risorsa:* Questo è l'identificatore pubblico (uno tra ROR, GRID, Ringgold**, Open Funder ID, LEI) per l'organizzazione che ospita la risorsa
- URL della proposta: Un link alla proposta
- Data di inizio della proposta: La data di inizio dell'accesso
- Data di fine della proposta: La data in cui l'accesso è terminato o finirà
* Indica campo obbligatorio required
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
- Ruolo:* Il ruolo della persona nel processo di revisione, che può essere selezionato tra: presidente, editore, membro, organizzatore, revisore
- Identificatore di gruppo:* Il gruppo ID che viene utilizzato per scopi di aggregazione: per gli articoli di riviste, l'identificatore predefinito è eISSN, che viene popolato automaticamente tramite un'integrazione con il database ISSN. Si prega di notare che se è necessario assegnare un identificatore diverso da un ISSN sarà necessario crearlo prima.
- Organizzazione della convocazione*: L'organizzazione che ha organizzato la revisione: editore di riviste, organizzatore di conferenze, agenzia di finanziamento, facoltà, ecc
- Identificatore dell'organizzazione: L'identificatore persistente dell'organizzazione convocante. Attualmente supportiamo l'identificatore ROR, Ringgold**, GRID, LEI o Crossref Funder Registry. Nota: questo non è un campo obbligatorio ma ti consigliamo di pubblicare questi dati se li hai a disposizione.
- Dati di revisione:* Questi dati si riferiscono all'attività di revisione e non a ciò che è stato recensito
- Tipo: Il tipo di attività di revisione: revisione o valutazione
- Data: la data in cui è stata completata la revisione. Questo può essere ampio (2008) o specifico (2010-12-10)
- Identificatore della recensione: Un unico, preferibilmente risolvibile identificatore fornito dalla fonte della recensione stessa. A meno che la recensione non sia apertamente disponibile, raccomandiamo che questa non contenga dati identificabili che possano essere ricondotti all'oggetto della recensione
- URL recensione: Un collegamento a una rappresentazione della recensione o del record di recensione online
- Informazioni sull'oggetto della recensione: Qualunque cosa abbia recensito il recensore
- Tipo di soggetto: Il tipo di elemento che è stato recensito, ad esempio articolo di giornale, documento di conferenza conference
- Questo include il elenco dei tipi di lavoro E l'elenco dei tipi di sovvenzione (“sovvenzione”, “contratto”,”premio”,”premio-stipendio”) AND ricerca-“proposta-risorsa” AND “indefinito”
- Nome soggetto: Il nome dell'articolo recensito
- Identificatore esterno del soggetto: L'identificatore univoco dell'oggetto della recensione, ad esempio un articolo DOI
- Nome contenitore oggetto: Il nome dell'oggetto di cui fa parte l'oggetto della revisione, ad esempio la conferenza per la quale è stato recensito l'articolo
- URL oggetto: L'URL dell'oggetto che è stato recensito
- Tipo di soggetto: Il tipo di elemento che è stato recensito, ad esempio articolo di giornale, documento di conferenza conference
* Indica campo obbligatorio required
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
- Tipo di finanziamento:* Il tipo di finanziamento assegnato, Questo campo è selezionato da un elenco contenente i seguenti valori: Premio, Contratto, Sovvenzione, Premio di stipendio
- Titolo finanziamento:* Il titolo della voce di finanziamento
- Sottotitolo: Un sottotitolo per l'elemento di finanziamento
- Titolo tradotto: Il titolo sotto il finanziamento appare in un'altra lingua, la lingua del titolo tradotto è registrata come attributo
- Descrizione: Una descrizione o un breve riassunto del progetto finanziato.
- Quantità: Il valore del premio
- Identificatore univoco di finanziamento: Aggiungi tanti di questi quanti ne conosce il tuo sistema, in quanto aiuta nel raggruppamento su ORCID Records.
- Tipo di identificatore di finanziamento: utilizza il numero di concessione, DOI, URI o ID proposta
- Valore dell'identificatore
- URL identificativo (facoltativo)
- Relazione: sé/parte di
Questo serve per indicare la relazione dell'elemento di finanziamento con l'identificatore. Ad esempio, se l'elemento di finanziamento è per una fase di una sovvenzione in più parti e l'identificatore è per la sovvenzione in più parti, la relazione sarebbe "parte di"; se l'identificatore è per la fase individuale, allora la relazione sarebbe "sé".
- Agenzia di finanziamento (organizzazione):* Informazioni sull'organizzazione che ha assegnato il finanziamento
- Nome dell'agenzia
- Indirizzo (città e paese)
- Identificatore dell'organizzazione:
- Data d'inizio: La data di inizio del finanziamento
- Data di fine: La data di scadenza del finanziamento
- Informazioni sui contributori: Informazioni sulle persone che hanno ricevuto il finanziamento
- ORCID ID: La ORCID iD di ciascun collaboratore al progetto di finanziamento; questo dovrebbe includere solo autenticato ORCID iD
- Ruolo: La natura del contributo del ricercatore
* Indica campo obbligatorio required
Tutte le sezioni di affiliazione utilizzano lo stesso set di metadati nell'API:
- Nome dell'organizzazione:* Il nome dell'organizzazione di livello più alto (ad es. “Boston University”, anziché “Boston University School of Medicine”).
- Città dell'organizzazione:* Città in cui ha sede l'organizzazione.
- Regione dell'organizzazione: Regione in cui ha sede l'organizzazione.
- Paese dell'organizzazione* il paese dell'organizzazione. Questo dovrebbe essere popolato con il codice paese a due lettere ISO 3166 Alpha-2.
- Organizzazione ID (ROR, GRID, Ringgold** o LEI):* Un identificatore univoco per l'organizzazione e la sua fonte. Raccomandiamo che l'organizzazione madre ID viene utilizzato all'interno dell'affiliazione e non della divisione o del dipartimento.
- Ruolo/Titolo: La posizione ricoperta, o il titolo di studio conseguito o da conseguire.
- Dipartimento: Qualsiasi suddivisione dell'organizzazione madre.
- URL: Un URL a una risorsa sull'affiliazione
- Data d'inizio: La data di inizio del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno).
- Data di fine: La data di fine del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno)
- Un identificatore persistente esterno che descrive l'affiliazione: Un identificatore univoco per l'effettiva asserzione di affiliazione
*Indica un campo richiesto.
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
Tutte le sezioni di affiliazione utilizzano lo stesso set di metadati nell'API:
- Nome dell'organizzazione:* Il nome dell'organizzazione di livello più alto (ad es. “Boston University”, anziché “Boston University School of Medicine”).
- Città dell'organizzazione:* Città in cui ha sede l'organizzazione.
- Regione dell'organizzazione: Regione in cui ha sede l'organizzazione.
- Paese dell'organizzazione* il paese dell'organizzazione. Questo dovrebbe essere popolato con il codice paese a due lettere ISO 3166 Alpha-2.
- Organizzazione ID (ROR, GRID, RInggold** o LEI):* Un identificatore univoco per l'organizzazione e la sua fonte. Raccomandiamo che l'organizzazione madre ID viene utilizzato all'interno dell'affiliazione e non della divisione o del dipartimento.
- Ruolo/Titolo: La posizione ricoperta, o il titolo di studio conseguito o da conseguire.
- Dipartimento: Qualsiasi suddivisione dell'organizzazione madre.
- URL: Un URL a una risorsa sull'affiliazione
- Data d'inizio: La data di inizio del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno).
- Data di fine: La data di fine del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno)
- Un identificatore persistente esterno che descrive l'affiliazione: Un identificatore univoco per l'effettiva asserzione di affiliazione
*Indica un campo richiesto.
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
Tutte le sezioni di affiliazione utilizzano lo stesso set di metadati nell'API:
- Nome dell'organizzazione:* Il nome dell'organizzazione di livello più alto (ad es. “Boston University”, anziché “Boston University School of Medicine”).
- Città dell'organizzazione:* Città in cui ha sede l'organizzazione.
- Regione dell'organizzazione: Regione in cui ha sede l'organizzazione.
- Paese dell'organizzazione* il paese dell'organizzazione. Questo dovrebbe essere popolato con il codice paese a due lettere ISO 3166 Alpha-2.
- Organizzazione ID (ROR, Ringgold**, GRID o LEI):* Un identificatore univoco per l'organizzazione e la sua fonte. Raccomandiamo che l'organizzazione madre ID viene utilizzato all'interno dell'affiliazione e non della divisione o del dipartimento.
- Ruolo/Titolo: La posizione ricoperta, o il titolo di studio conseguito o da conseguire.
- Dipartimento: Qualsiasi suddivisione dell'organizzazione madre.
- URL: Un URL a una risorsa sull'affiliazione
- Data d'inizio: La data di inizio del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno).
- Data di fine: La data di fine del rapporto tra il ricercatore e l'organizzazione (può essere specificata fino a anno, mese e giorno)
- Un identificatore persistente esterno che descrive l'affiliazione: Un identificatore univoco per l'effettiva asserzione di affiliazione
*Indica un campo richiesto.
**Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni.
An ORCID il record può contenere informazioni sul lavoro di un ricercatore, affiliazioni, finanziamenti, revisione paritaria e altro.
Articoli su ORCID i record possono essere suddivisi in asserzioni che collegano il ORCID Titolare di iD con un'attività o affiliazione. Queste affermazioni possono essere aggiunte a ORCID record dal ricercatore che possiede il record, o dai sistemi che il ricercatore ha autorizzato a farlo. Chiamiamo l'entità che ha aggiunto un'asserzione a an ORCID registra il file source.
Esempi


Seguendo i nostri principi di trasparenza e apertura, riteniamo che sia importante essere in grado di vedere la fonte dell'affermazione, ovvero chi aggiunge tali informazioni al registro. Ecco come lo facciamo:
- Quando un ricercatore (o un suo delegato persona fidata) aggiunge un'affermazione al proprio verbale, ORCID registra automaticamente quella persona come fonte
- Quando un sistema approvato dal ricercatore aggiunge un'asserzione a un record, ORCID registra automaticamente il proprietario del sistema (un ORCID membro) come fonte.
Mostriamo il nome della sorgente nell'interfaccia utente e lo rendiamo disponibile (con il suo identificatore univoco) nell'API:
Tuttavia, i flussi di lavoro delle informazioni di ricerca possono essere più complicati di così e la vera fonte di un'asserzione può essere oscurata involontariamente da un sistema che aggiunge un elemento per conto di una persona o di un altro sistema. Per garantire la trasparenza, dobbiamo distinguere tra chi ha creato il collegamento tra la persona e l'elemento e chi ha aggiunto l'elemento al record. Come sopra, chi aggiunge l'oggetto al ORCID il record è il source; chiunque crei la connessione tra il ORCID iD e l'oggetto è il origine dell'asserzione.
Per esempio:
- Un ricercatore importa i dati nel proprio ORCID record da un sistema, ad esempio una procedura guidata di ricerca e collegamento. Il ricercatore sta facendo l'asserzione collegando il loro iD con l'oggetto, quindi sono i origine dell'asserzione; mentre il sistema è l'entità che aggiunge l'asserzione al ORCID registrare - il source
- Un ricercatore interagisce con il Sistema A (il asserzione origin), che utilizza i servizi forniti dal Sistema B per aggiornare ORCID record, rendendo il sistema B il source

Incoraggiamo la nostra comunità a impegnarsi nell'adozione di misure per preservare e condividere le informazioni sull'origine dell'asserzione, in modo che tutti possano trarre vantaggio dal vedere la fonte.
Per ulteriori informazioni, si prega di consultare:
Lavori in ORCID sono raggruppati in base sia ai loro identificatori che a tali identificatori‚ in relazione all'opera. Esistono quattro tipi di relazioni:
- Auto: l'identificatore si riferisce esclusivamente a quell'opera e può essere raggruppato con altre opere che hanno lo stesso identificatore
- Parte di: l'opera fa parte di questo identificatore e non può essere raggruppata con altre opere
- Versione di: questi identificatori si applicano a versioni alternative dell'opera e possono essere raggruppati con sé e versione degli identificatori
- Fondato da: questi identificatori si applicano al finanziamento dell'opera. Questi identificatori non vengono utilizzati per raggruppare le opere.
La nostra API fornisce supporto per questo nell'XSD. Ogni elemento ha un attributo dell'indice di visualizzazione che indica il suo rango all'interno del suo gruppo. L'indice di visualizzazione più alto è l'elemento preferito selezionato dal ricercatore, gli elementi aggiunti tramite l'API che non sono stati classificati dal ricercatore hanno un indice di visualizzazione pari a 0. L'indice di visualizzazione determina anche l'ordine di lavoro durante la lettura del ORCID record.
Per ulteriori informazioni sul raggruppamento su ORCID record, si prega di consultare il nostro articolo di supporto.
ORCID consente l'aggiunta di diversi tipi di opere. Di seguito è riportato un elenco dei tipi di lavoro attualmente supportati, che è ampiamente coerente con lo standard di output CASRAI.
Pubblicazioni
Tipo di lavoro | Usa il |
libro | Libri scritti da un singolo autore o basati in collaborazione su ricerche o risultati accademici generalmente derivati da finanziamenti sottoposti a revisione paritaria. |
capitolo-libro | Testi scritti da un singolo autore o basati in collaborazione su ricerche o risultati accademici e competenze in un campo. |
recensione del libro | Revisione critica di opere di narrativa o saggistica che evidenzino i contributi a un'arte, un campo o una disciplina. |
voce-dizionario | Inserimento di nuove parole, nuovi significati di parole esistenti, cambiamenti nell'ortografia e nella sillabazione in un periodo di tempo più lungo e cambiamenti grammaticali. |
dissertazione | Trattato che avanza un punto di vista originale derivante dalla ricerca: un requisito per un dottorato. Disponibile solo con API v2.x |
tesi di laurea | Un elaborato tipicamente basato su ricerche originali e che dimostri la padronanza del candidato sia della propria materia sia del metodo scientifico. Questo è disponibile solo con API v3.0+ |
enciclopedia-entry | Voci scritte in un'opera di riferimento o in un compendio incentrato su un particolare dominio o su tutti i rami della conoscenza. |
libro-edito | Libri editi da un singolo autore o in collaborazione per la diffusione di ricerche o risultati accademici che generalmente derivano da finanziamenti peer reviewed. |
articolo di giornale | Articoli in pubblicazioni peer-reviewed che diffondono i risultati di ricerche originali e borse di studio. |
numero-giornale | Pubblicazioni periodiche volte a favorire il dibattito intellettuale e l'indagine. |
articolo di rivista | Articoli in pubblicazioni tematiche pubblicate ad intervalli prestabiliti. |
Manuale | Materiali del corso e dei compiti prodotti a fini didattici. |
risorsa-online | Informazioni accessibili solo via web con modalità tecniche tradizionali |
articolo-newsletter | Articoli in pubblicazioni rivolti a ricercatori, decisori, professionisti e pubblico che riferiscono su un progetto di ricerca o sull'attività di una cattedra di ricerca o di un centro di ricerca. |
articolo di giornale | Articoli in una pubblicazione quotidiana, settimanale o mensile che riportano notizie e questioni sociali rivolte al pubblico. |
preprint | Versione di un documento resa pubblicamente disponibile prima della revisione formale e della pubblicazione tra pari. Disponibile solo con API v3.0+ |
rapporto | Rapporti che diffondono i risultati e i deliverable di un contratto di ricerca. |
recensioni | Una valutazione formale del lavoro di un altro. Questo è disponibile solo con API v3.0+ |
strumento di ricerca | Serie di osservazioni, misurazioni o fatti individuati dalla ricerca. |
pubblicazione-studente-sorvegliata | Articoli sui risultati della ricerca pubblicati congiuntamente o sotto la supervisione del relatore di tesi. |
test | Valutazioni che includono test progettati per la selezione universitaria generale, la selezione in corsi specifici o altri scopi di valutazione. |
traduzione | Traduzioni di libri e articoli che identificano modifiche all'edizione originale, come una prefazione nuova o rivista. |
sito web | Posizioni autonome sul Web in cui sono disponibili più tipi di informazioni su un tema specifico. |
foglio di lavoro | Versioni preliminari di articoli che non sono stati sottoposti a revisione ma che possono essere condivisi per un commento. |
Conferenza
Tipo di lavoro | Usa il |
conferenza-abstract | Testi di una lunghezza specificata che espongono la questione da discutere in un documento di conferenza proposto. |
carta per la conferenza | Articoli scritti da soli o in collaborazione, presentati a una conferenza accademica e pubblicati negli atti (non su riviste accademiche). |
poster-conferenza | Poster visualizzati in un ambiente congressuale e che trasmettono i punti salienti della ricerca in modo efficiente tramite una grafica accattivante. |
Proprietà intellettuale
Tipo di lavoro | Usa il |
Rivelazione | Pubblicazioni che stabiliscono le invenzioni come arte anteriore, impedendo così ad altri di brevettare la stessa invenzione o concetto. |
licenza | Accordi firmati per sfruttare una parte di proprietà intellettuale come un processo, un prodotto, dati o software. |
brevetto | Una forma di protezione della PI che definisce il diritto esclusivo per legge per inventori e assegnatari di utilizzare e sfruttare le loro invenzioni, prodotti o processi, per un periodo di tempo limitato. |
copyright-registrato | Proprietà registrata dei diritti nell'ambito di un sistema di leggi per promuovere sia la creazione che l'accesso alle opere artistiche, letterarie, musicali, drammatiche e altre opere creative. |
marchio | Marchi come un nome, una parola, una frase, un logo, un simbolo, un design, un'immagine di un prodotto o servizio che indica la fonte e fornisce il diritto di controllare l'uso dell'identificatore. |
Altro
Tipo di lavoro | Usa il |
annotazione | Le annotazioni contengono commenti o descrizioni su un'altra risorsa. Disponibile solo con API v3.0+ |
performance artistica | Raccolta di documenti informativi che, in combinazione, rappresentano una storia completa e aggiornata dei prodotti artistici o performativi derivanti da o relativi alle attività di ricerca o accademiche della persona. |
gestione-dati-pla | Una dichiarazione formale che descriva come i dati di ricerca saranno gestiti e documentati nel corso di un progetto di ricerca e i termini relativi al successivo deposito dei dati presso un archivio dati per la gestione e la conservazione a lungo termine. Disponibile solo con API v3.0+ |
set di dati | Una serie di osservazioni, misurazioni o fatti strutturati identificati dalla ricerca che possono essere archiviati in un supporto di database. |
invenzione | Output pratici e originali derivanti dalla ricerca. |
conferenza-discorso | Un discorso informativo relativo alla ricerca consegnato a un pubblico. |
oggetto-fisico | Un esemplare, campione o altro oggetto fisico utilizzato per scopi di ricerca; un oggetto o una sostanza tridimensionale inanimato. Disponibile solo con API v3.0+ |
tecnica di ricerca | A metodi pratici o abilità applicate a particolari compiti identificati come parte della ricerca. |
Software | Un programma utilizzato per far funzionare un computer o un altro dispositivo tecnico. |
società spin-off | Una società costituita da un ente di ricerca per fare uso commerciale dei risultati e dei risultati del progetto di ricerca. |
norme-e-politiche | Lo sviluppo di una regola o principio che viene utilizzato come base per il giudizio. |
standard tecnico | Standard tecnici (industriali e non) che hanno avuto origine dai progetti di ricerca in cui possono essere sviluppati nuovi protocolli, metodi o materiali. |
Altro | Qualsiasi altro tipo di lavoro. |
Si prega di consultare il nostro elenco di identificatori supportati per l'API V3.0. Occasionalmente aggiungiamo nuovi tipi su richiesta di ORCID membri che desiderano utilizzarli quando aggiungono elementi al registro.
ORCID supporta l'uso di Identificatori ROR, Identificatori GRIGLIA o Registro dei finanziatori Crossref identificatori per disambiguare le organizzazioni in ORCID Records.
Per ulteriori informazioni, vedere Lavorare con gli identificatori dell'organizzazione
Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni
Abbiamo introdotto un nuovo campo generato dal sistema, che esprime identificatori esterni (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN e ISBN) in un formato normalizzato ai fini della corrispondenza e del raggruppamento. La normalizzazione viene eseguita in base alle regole del tipo di identificatore e può includere l'impostazione di tutti i caratteri alfa in minuscolo o la trasformazione di spazi, trattini, punti e altri caratteri che possono essere trattati come equivalenti. Aggiunge anche prefissi e suffissi standard a seconda dei casi. Per esempio, https://doi.org/10.1/123, 10.1/123e https://dx.doi.org/10.1/123 appariranno tutti in questo campo come https://doi.org/10.1/123. Il valore dell'identificatore esistente non è modificato.
- Nome
- aggiuntivo
Ruoli per le opere API 2.0
Di seguito è riportato l'elenco dei ruoli di contributore supportati utilizzando l'API 2.0.- autore
- assegnatario
- editore
- sedia-o-traduttore
- co-investigatore
- co-inventore
- studente laureato
- altro-inventore
- investigatore principale
- ricercatore-post-dottorato
- personale di supporto
Ruoli per le opere API 3.0
Con l'API 3.0, puoi aggiungere i ruoli sopra e altri ruoli CRedIT. La tassonomia di CRediT consiste in 14 tipi di contributo al lavoro accademico, insieme a linee guida su come questi ruoli possono essere assegnati. Di seguito è riportato l'elenco completo con il valore dell'interfaccia utente e il valore dei metadati. Il valore dei metadati è l'URL secondo le raccomandazioni di implementazione NISO 'CRediT dovrebbe essere codificato in JATS xml v1.2, descritto tramite questo link: https://jats4r.org/credit-taxonomy. ' Solo l'URL sarà accettato quando si aggiungono ruoli tramite l'API.Esempio di metadati del collaboratore di lavoro:
https://orcid.org/0000-0001-5109-3700 0000-0001-5109-3700 orcid.org Laure L. Haak first author
Ruoli per il finanziamento
- portare
- co-protagonista
- sostenuto da
- altro-contributo
ORCID fornisce un campo di citazione di testo libero in modo che le informazioni possano essere facilmente inserite in formato testo dai ricercatori. Tuttavia, consigliamo vivamente a tutti gli utenti API di aggiungere citazioni in BibTeX, che è leggibile dalla macchina. Il venerabile formato, nonostante preceda Internet, può essere trasformato nel formato desiderato da integrazioni e autori. È supportato dalla maggior parte dei gestori di riferimento e delle piattaforme di pubblicazione
Per ulteriori informazioni su BibTeX, vedere https://www.bibtex.org.
Qualsiasi autore il cui editore utilizza Crossref per la registrazione DOI può beneficiare dell'integrazione dell'aggiornamento automatico di Crossref.
Gli editori devono includere l'autenticato ORCID iD per i loro autori all'interno dei metadati inviati a Crossref al momento della registrazione DOI.
Crossref chiederà quindi il permesso all'autore tramite una notifica al suo ORCID posta in arrivo per aggiornare la loro ORCID registrare con questa pubblicazione e qualsiasi nuova pubblicazione di qualsiasi editore.
Per ulteriori informazioni, vedere: https://www.crossref.org/community/orcid/
Ogni articolo in ORCID iD viene assegnato un codice put che lo identifica in modo univoco. Quando si legge un intero record o sezione, il codice put può essere trovato come attributo dell'articolo. quando chiamare un elemento specifico su un record, il codice put viene utilizzato per identificare l'articolo. I codici put sono unici all'interno del tipo di articolo a cui si riferiscono. Usando questo esempio, solo un lavoro nel ORCID Il registro avrà il codice put 733535, sebbene 733535 possa anche essere usato come codice put per un elemento di finanziamento o una parola chiave
Come vantaggio di ORCID l'adesione, le organizzazioni possono chiedere ORCID per supportare ulteriori tipi di PID nel ORCID Registro. Ad esempio, un membro potrebbe richiedere di aggiungere il supporto per i PID che utilizza per identificare campioni o set di dati nel proprio database geologico. Ciò consente collegamenti tra i campioni e le persone che li hanno raccolti. E, poiché tutti i nuovi tipi di PID che aggiungiamo devono essere almeno risolvibili e preferibilmente FAIR, quei collegamenti sono inequivocabili, persistenti nel tempo e attuabili, a vantaggio del ricercatore, dell'organizzazione membro e della comunità più ampia.
Aggiungi il tuo PID!
Come organizzazione comunitaria, vogliamo garantire che ORCID supporta i PID utilizzati dai nostri membri. Manteniamo un completo elenco degli identificatori esistenti supportati nel registro e invitare ORCID membri da usare questa forma per richiedere ulteriori PID. Cerchiamo di rispondere alla tua richiesta il prima possibile.
ORCID ha una sezione separata in ORCID record per registrare informazioni su qualifiche, accreditamenti, certificati e badge.
Ogni elemento di qualificazione conterrà sempre:
- Il titolo di qualifica
- L'organizzazione del fornitore ID (es. ID ROR)
- La data in cui è stato aggiunto al ORCID record
- Chi ha aggiunto la qualifica (la fonte)
Possono contenere:
- La data di validità, inclusa una data di fine se la qualifica scade
- L'ID persistente della qualifica, che identifica il tipo di qualifica acquisita.
- L'URL della qualifica, che contiene una descrizione leggibile dal tipo di qualifica ottenuta.
- L'ID persistente della qualifica. Questo dovrebbe collegarsi a una versione online del certificato di qualificazione. Questo potrebbe essere un unico esistente ID o semplicemente un URI.
Autenticazione e OAuth
Chiunque disponga di credenziali API pubbliche o membro può ricevere un /leggi-pubblico token di accesso. Per ottenere un token, fai una chiamata al ORCID Endpoint del token API.
Questo processo viene spesso definito flusso OAuth delle credenziali client o OAuth in due passaggi.
Una chiamata di esempio per ottenere un token di accesso per leggere i dati pubblici sulla sandbox: sostituire i segnaposto con le proprie credenziali (assicurarsi di rimuovere le parentesi.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
METHOD: POST
DATA:
client_id=[Your public API client ID]
client_secret=[Your public API secret]
grant_type=client_credentials
scope=/read-public
Ti verrà quindi restituito un token di accesso simile al seguente. Il token restituito è di lunga durata (non scade per circa 20 anni) e può essere utilizzato più volte per recuperare dati pubblici da ORCID Records.
{"access_token":"4bed1e13-7792-4129-9f07-aaf7b88ba88f","token_type":"bearer",
"refresh_token":"2d76d8d0-6fd6-426b-a017-61e0ceda0ad2","expires_in":631138518,
"scope":"/read-public","orcid":null}
Nota: Tutti i token con l'ambito /authenticate ora includono anche l'ambito /read-public. Se usi solo l'ambito /authenticate, puoi usare i token di accesso archiviati per leggere i dati pubblici senza dover ottenere nuovamente un token di accesso.
Per ottenere l'accesso/lettura limitato, è necessario chiedere l'autorizzazione al ricercatore. Lo fai usando OAuth. Nello specifico, “OAuth a 3 zampe".
Per ulteriori informazioni, consultare il nostro Tutorial API: leggere i dati su un ORCID record
ORCID integrazioni utilizzano "OAuth a 3 vie" per autenticare gli utenti e richiedere l'autorizzazione per interagire con i loro record. Qualsiasi integrazione può richiedere autorizzazioni di lettura utilizzando l'API pubblica. ORCID i membri possono utilizzare l'API dei membri per richiedere le autorizzazioni di aggiornamento. Funziona così:
- Crei un collegamento speciale
- Quando si fa clic, l'utente viene inviato a ORCID
- ORCID chiede all'utente di accedere
- ORCID chiede all'utente di concedere l'autorizzazione alla tua applicazione
- ORCID rimanda l'utente al tuo sistema con un codice di autorizzazione
- Il tuo sistema scambia quel codice con un token di accesso
L'URL di autorizzazione personalizzato include le informazioni del tuo cliente, nonché gli "ambito" che specificano le aree specifiche del loro record a cui desideri accedere. Dopo l'accesso, l'utente autorizza la connessione con il tuo sistema e viene restituito alla tua pagina di destinazione insieme a un codice di autorizzazione. Questo codice viene quindi utilizzato per ottenere il loro ORCID iD insieme a un token di accesso valido per gli ambiti richiesti.
Crei il tuo link di autorizzazione specificando il client delle tue credenziali API ID e pagina di destinazione associata (URI di reindirizzamento). Scegli quali autorizzazioni richiedere impostando il parametro di ambito.
L'esempio seguente richiede il permesso di leggere i dati ad accesso limitato sul ORCID server di test sandbox. Nel mondo reale visualizzi questo collegamento sul tuo sito Web o lo includi in un'e-mail quando chiedi all'utente di autenticarsi e autorizzare. Tuttavia, a scopo di test, puoi semplicemente incollarlo nel tuo browser web. Sostituisci i dati tra parentesi con le informazioni del tuo cliente e assicurati di rimuovere le parentesi quadre!
https://sandbox.orcid.org/oauth/authorize?client_id=[Your client ID]&response_type=code&scope=/read-limited&redirect_uri=[Your landing page]
Una volta che l'utente ha fatto clic sul collegamento, ha effettuato l'accesso a ORCID e le autorizzazioni concesse vengono reindirizzate al tuo sito, in questo modo:
https://[Your landing page]?code=Q70Y3A
È necessario scambiare immediatamente il codice di autorizzazione per il ORCID iD e token di accesso. Il codice di autorizzazione scade al momento dell'uso. La richiesta è simile a questa e non può essere fatto in un browser web, deve essere creato dal tuo server.
URL=https://sandbox.orcid.org/oauth/token
HEADER: Accept: application/json
HEADER: Content-Type: application/x-www-form-urlencoded
METHOD: POST
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
grant_type=authorization_code
code=Six-digit code
redirect_uri=[Your landing page]
ORCID restituirà quindi l'autenticazione del ricercatore ORCID iD e un token di accesso in formato JSON:
{"access_token":"f5af9f51-07e6-4332-8f1a-c0c11c1e3728","token_type":"bearer",
"refresh_token":"f725f747-3a65-49f6-a231-3e8944ce464d","expires_in":631138518,
"scope":"/read-limited","name":"Sofia Garcia","orcid":"0000-0001-2345-6789"}
I token di accesso sono di lunga durata per impostazione predefinita e scadono 20 anni dopo l'emissione. Il token può essere utilizzato più volte prima della scadenza.
Usa il token di accesso
I token di accesso a 3 gambe sono collegati a specifici ORCID disco. Per usarli, li includi nelle richieste API che fai per leggere o aggiornare quel record.
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.
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.
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 |
Inglese | 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 |
È possibile utilizzare uno o tutti i parametri:
Parametro | Settore | Note |
nomi di battesimo | Nome | La 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 | La 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. |
La 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 orcid parametro. | ||
orcid | ORCID iD | La 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

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
OAuth implicito è una versione più leggera di OAuth progettata per essere utilizzata da sistemi che non dispongono o non desiderano utilizzare componenti lato server. L'OAuth implicito può essere implementato interamente nel browser utilizzando solo javascript. È disponibile per membri e non membri e funziona in questo modo:
- Crei un collegamento speciale
- Quando si fa clic, l'utente viene inviato a ORCID
- ORCID chiede all'utente di firmare i
- ORCID chiede all'utente di concedere l'autorizzazione alla tua applicazione
- ORCID rimanda l'utente al tuo sistema con il suo ORCID iD, un token di accesso e un id gettone.
- Il tuo sistema estrae e memorizza gli autenticati ORCID iD dalla risposta.
Per motivi di sicurezza, quando si utilizza OAuth implicito, ORCID non restituirà token di accesso con autorizzazioni di aggiornamento.
Flusso implicito
Il flusso implicito è progettato in modo che i client non debbano utilizzare la loro chiave segreta per avviare ORCID accedi. La sicurezza viene applicata limitando i client ai loro redirect_urls registrati. Questo livello di sicurezza inferiore significa che ORCID supporta solo gli ambiti /authenticate e openid quando si usa il flusso implicito. I token sono anche di breve durata, con una durata di 10 minuti. Questo flusso è consigliato per le applicazioni lato client che non hanno accesso a un server di back-end, ad esempio applicazioni telefoniche o applicazioni web javascript a pagina singola.
https://localhost/#access_token=24c11342-f5da-4cf9-94a4-f8a72a30da00&token_type=bearer&expires_in=599&tokenVersion=1&persistent=false&id_token=eyJraWQiOiJxYS1vcmNpZC1vcmctcjlhZmw3cWY2aG2c5bmdzenU1bnQ3Z3pmMGVhNmkiLCJhbGciOiJSUzI1NiJ9.eyJhdF9oYXNoIjoiMW52bXZBbVdwaVd0Z3ZKZW1DQmVYUSIsImF1ZCI6IkFQUC02TEtJSjNJNUIxQzRZSVFQIiwic3ViIjoiMDAwMC0wMDAyLTUwNjItMjIwOSIsImF1dGhfdGltZSI6MTUwNTk4Nzg2MiwiaXNzIjoiaHR0cHM6XC9cL29yY2lkLm9yZyIsIm5hbWUiOiJNciBDcmVkaXQgTmFtZSIsImV4cCI6MTUwNTk4ODQ2MywiZ2l2ZW5fbmFtZSI6IlRvbSIsImlhdCI6MTUwNTk4Nzg2Mywibm9uY2UiOiJ3aGF0ZXZlciIsImZhbWlseV9uYW1lIjoiRGVtIiwianRpIjoiY2U0YzlmNWUtNTBkNC00ZjhiLTliYzItMmViMTI0ZDVkNmNhIn0.hhhts2-4-ibjXPW6wEsFRaNqV_A-vTz2JFloYn7mS1jzQt3xuHiSaSIiXg3rpnt1RojF_yhcvE9Xe4SOtYimxxVycpjcm8yT_-7lUSrc46UCt9qW6gV7L7KQyKDjNl23wVwIifpRD2JSnx6WbuC0GhAxB5-2ynj6EbeEEcYjAy2tNwG-wcVlnfJLyddYDe8AI_RFhq7HrY4OByA91hiYvHzZ8VzoRW1s4CTCFurA7DoyQfCbeSxdfBuDQbjAzXuZB5-jD1k3WnjqVHrof1LHEPTFV4GQV-pDRmkUwspsPYxsJyKpKWSG_ONk57E_Ba--RqEcE1ZNNDUYHXAtiRnM3w
vedere il nostro documentazione tecnica per maggiori informazioni.
Cosa sono gli URI di reindirizzamento e come vengono utilizzati?
Gli URI di reindirizzamento vengono utilizzati dal nostro servizio di autenticazione OAuth come misura di sicurezza. ORCID invierà solo gli utenti di autenticazione agli URI registrati dal client che richiede l'autenticazione. Ciò impedisce ai servizi di impersonarsi a vicenda.
Si prega di notare che solo URI HTTPS sono accettati in produzione. Puoi testare utilizzando gli URI HTTP ma dovrai registrarti URI HTTPS quando richiedi le credenziali dell'API del membro di produzione.
Come abbiniamo gli URI di reindirizzamento?
- DEVI registrare i sottodomini come URI separati. https://anythingelse.thirdparty.com non funzionerà.
- È incoraggiata la registrazione completa di tutti gli URI di reindirizzamento, incluso il percorso, è ciò che fanno la maggior parte delle terze parti ed è l'opzione più sicura.
- Se l'app client è registrata con un uri di reindirizzamento che è solo il nome host, è possibile utilizzare qualsiasi uri di reindirizzamento su quell'host. Quindi, ad esempio, se è registrato il seguente reindirizzamento uri: https://thirdparty.com quindi tutti i seguenti redirect_uris funzioneranno:
- https://thirdparty.com/oauth/callback1
- https://thirdparty.com/callback2
- https://thirdparty.com/anything-else-as-long-as-the-host-is-the-same
Tuttavia, https://anythingelse.thirdparty.com non funzionerà. Tu MUST registra i sottodomini come URI separati.
Cosa succede se il mio URI di reindirizzamento non è corretto?
Utenti inviati per autenticarsi a ORCID con URI di reindirizzamento errati verrà visualizzato un messaggio di errore simile a questo:
Gestione degli URI di reindirizzamento per i membri
Se stai utilizzando l'API membro e richiedi modifiche ai tuoi URI di reindirizzamento, contatta il nostro team di coinvolgimento
Gestione degli URI di reindirizzamento per client pubblici
Se stai utilizzando l'API pubblica, dovrai seguire i passaggi seguenti per aggiornare l'elenco degli URI di reindirizzamento associati al tuo ORCID ID client API pubblico. Puoi farlo seguendo i passaggi seguenti:
- Accedi al tuo ORCID record
- Fai clic sul tuo nome nell'angolo destro
- Seleziona gli strumenti per sviluppatori
- Fare clic sulla matita di modifica accanto al nome del cliente
- Modifica un URI di reindirizzamento esistente o fai clic su "Aggiungi un altro URI di reindirizzamento" modificane uno esistente
- Una volta apportate le modifiche, è necessario fare clic sull'icona di salvataggio
Solo URI HTTPS sono accettati in produzione. Puoi eseguire il test utilizzando gli URI http, ma dovrai registrare gli URI HTTPS quando richiedi le credenziali dell'API del membro di produzione.
OpenID Connect 1.0 è un semplice livello di identità al di sopra del protocollo OAuth 2.0. Integra i flussi di autenticazione OAuth esistenti e fornisce informazioni sugli utenti ai client in modo ben descritto.
OpenID connect è un modo standardizzato di implementare OAuth e condividere informazioni sugli utenti autenticati. Sarà ora possibile configurare i servizi da utilizzare ORCID "pronto all'uso" insieme ad altri fornitori di connessione OpenID conformi agli standard. OpenID connect fornisce anche condivisibili ID token, che sono oggetti firmati che possono dimostrare che un utente è stato autenticato usando ORCID in un momento specifico. Questi token possono essere utilizzati dagli elementi dell'interfaccia utente per mantenere le sessioni utente.
ORCID supporta il profilo di conformità Basic OpenID Provider, che è un'estensione del flusso del codice di autorizzazione OAuth. ORCID supporta anche il flusso di token implicito per gli ambiti "/authenticate" e "openid".
Ciò significa che ORCID:
- Incorpora firmati id token all'interno di risposte token per codici di autorizzazione generati con l'ambito 'openid'
- Supporta il flusso implicito quando si utilizzano response_types 'token' o 'token id_token' e l'ambito 'openid'.
- Supporta i parametri 'prompt', 'nonce' e 'max_age' per le richieste di autorizzazione che includono l'ambito 'openid'.
- Supporta la scoperta di Openid Connect e gli endpoint di informazioni utente
- Supporta il campo "amr" per gli integratori che utilizzano l'API membro per le richieste di autorizzazione che includono l'ambito "openid". Questo può essere utilizzato per scoprire se un utente si è autenticato utilizzando l'autenticazione a due fattori.
L'avvio di un'autenticazione OpenID Connect funziona allo stesso modo di una normale autenticazione OAuth. Tutto ciò che è richiesto è che il client richieda l'ambito 'openid' Se si utilizza l'ambito /authenticate sostituirlo con openid, poiché autenticare e openid hanno la stessa autorizzazione solo uno o l'altro dovrebbe essere utilizzato. Se stai utilizzando altri ambiti, aggiungi openid all'elenco degli ambiti richiesti. 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.
Si noti che l'ambito 'openid' non inizia con un '/' come l'altro ORCID Ambiti API. Questo perché l'ambito 'openid' non è definito da ORCID, ma invece definito dalla specifica OpenID Connect.
vedere il nostro documentazione tecnica per maggiori informazioni.
ORCID consente agli utenti di abilitare Autenticazione a due fattori (2FA) sul loro ORCID account. 2FA è un controllo di sicurezza secondario effettuato durante il processo di accesso. Fornisce un'ulteriore conferma che l'utente è effettivamente la persona che accede a un ORCID account. Per ulteriori informazioni relative a come questo può essere configurato per gli utenti, vedere il nostro Articolo KB.
Apri ID gli integratori di connessione che utilizzano l'API membro possono verificare se l'utente ha effettuato l'accesso al loro ORCID account con 2FA abilitato come parte del processo OAuth. Ciò può consentire agli integratori membri di concedere l'accesso ai propri ricercatori a sistemi di sicurezza più elevati.
In linea con il nostro impegno per il controllo da parte dei ricercatori della loro ORCID record, il detentore del record può scegliere di revocare qualsiasi token di accesso in qualsiasi momento eliminandolo dalle autorizzazioni nel Organizzazione di fiducian sotto la loro pagina Parti attendibili.
A partire dal 2018, i ricercatori possono concedere solo token di accesso di lunga durata che durano 20 anni a meno che l'utente non revochi l'autorizzazione.
ORCID fornisce un semplice Widget Java Script che può essere utilizzato per ottenere l'autenticazione ORCID ID che utilizzano OAuth con OpenID Connect.
Tieni presente che il widget utilizza OAuth implicito, quindi non raccoglie alcuna autorizzazione di scrittura. Ciò significa che non è adatto per le integrazioni dei membri che desiderano aggiornare i record. Si prega di consultare il nostro tutorial per Aggiunta e aggiornamento dei dati su ORCID Records.
ORCID API
Le credenziali del cliente pubblico sono concesse a individui e non a organizzazioni. Le credenziali non possono essere trasferite da un individuo all'altro, ma possono essere convertite in credenziali API membro se si riceve un accordo da tutte le parti e l'organizzazione è un membro attivo di ORCID.
Spostamento del cliente ID alla Member API non altererà il Client ID, solo il Client Secret, e manterrai il numero di iD connessi con il tuo permesso di sola lettura.
Quando si converte il client API pubblico in un client API membro, il file Termini di servizio del cliente pubblico non si applicano più e sono sostituiti dai termini del Member Agreement.
Per il trasferimento avremmo bisogno di:
- Conferma del client API pubblico ID da convertire.
- Che sia il contatto principale dell'organizzazione e il detentore del record dell'attuale cliente dell'API pubblica ID accettare la modifica dei Termini di servizio. (Il detentore del record deve essere un dipendente, appaltatore o funzionario dell'organizzazione membro) Terremo un registro del consenso di entrambe le parti.
- Una data/ora in cui deve avvenire la migrazione. Come parte di questa migrazione, aggiorneremo il client ID e inviarti un nuovo segreto client in un'e-mail crittografata. Tieni presente che una volta aggiornato il client, la tua integrazione non funzionerà fino a quando non aggiornerai il client secret. Per questo occorre fissare una data e un orario per farlo e per evitare disagi per gli utenti.
Per completare la conversione, dovrai aggiornare:
- Dal vecchio segreto client al nuovo segreto client.
- L'host dell'API da pub.orcid.org a apiorcid.org.
Con l'ID client API membro convertito, puoi aggiornare gli ambiti da aggiungere ambiti dell'API membro. Ciò richiederà l'autorizzazione degli utenti e verranno generati nuovi token di accesso per includere i nuovi ambiti/autorizzazioni.
Tieni presente che non siamo in grado di convertire le credenziali dei client API membri in credenziali API pubbliche.
Questa chiamata di esempio recupera un riepilogo dell'intero ORCID registrare in formato XML utilizzando l'API membro sul server sandbox. È necessario un token di accesso per effettuare richieste API all'API pubblica o membro.
Method: GET
Accept: application/vnd.orcid+xml
Authorization type and Access token: Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
L'API restituirà un messaggio 200 OK, indicando che la richiesta è stata ricevuta con successo, e il riepilogo completo del ORCID record, compresi i riepiloghi dei singoli elementi
<?xml version="1.0" encoding-"UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789"
xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Ogni voce (lavoro, finanziamento, occupazione, ecc.) ha un metti il codice. Questo può essere utilizzato per ottenere i dettagli completi dell'articolo, se necessario.
La ORCID record è suddiviso in singole sezioni per rendere la lettura del record più veloce e coerente. Puoi prima chiamare una sezione per riceverne il riepilogo, quindi chiamare utilizzando il codice put di un singolo articolo per ricevere informazioni affidabili su quell'articolo.
Di seguito è riportata una tabella delle sezioni di riepilogo che è possibile leggere tramite l'API.
endpoint | Descrizione |
/disco | Vista riepilogativa dell'intero ORCID record |
/persona | Sezione biografica del ORCID record, anche tramite /researcher-urls di seguito |
/indirizzo | Paesi o regioni del ricercatore |
L'indirizzo e-mail associato al record | |
/identificatori-esterni | Identificatori esterni collegati in altri sistemi |
/parole chiave | Parole chiave relative al ricercatore e al suo lavoro |
/altri nomi | Altri nomi con cui il ricercatore è conosciuto |
/dati personali | Dati personali: nome del ricercatore, nome di credito (pubblicato) e biografia |
/URL-ricercatore | Collegamenti alle pagine personali o di profilo del ricercatore |
/attività | Riepilogo della sezione attività del ORCID record, anche tramite /works di seguito. |
/educazioni | Affiliazioni educative |
/occupazioni | Affiliazioni di lavoro |
/finanziamenti | Riepilogo delle attività di finanziamento |
/revisioni dei pari | Riepilogo delle attività di revisione tra pari |
/lavori | Sintesi dei lavori di ricerca |
/risorse-di-ricerca | Riepilogo delle risorse di ricerca |
/Servizi | Riepilogo dei servizi |
/titoli di studio | Riepilogo delle qualifiche |
/abbonamenti | Riepilogo delle iscrizioni |
/distinzioni | Riepilogo delle distinzioni |
/posizioni-invitate | Riepilogo delle posizioni invitate |
Gli elementi (lavori, occupazione, finanziamenti, revisione paritaria, ecc.) possono essere aggiunti a un ORCID registrare utilizzando il ORCID API membro. Avrai bisogno di quanto segue:
- Il permesso dei ricercatori
- Credenziali API dei membri
- E nemmeno:
- Un sistema di fornitori che si integra con il ORCID API membro
- Il tuo sistema che si integra con il ORCID API membro
Questa chiamata di esempio recupera un riepilogo dell'intero ORCID registrare in formato XML utilizzando l'API membro sul server sandbox. È necessario un token di accesso per effettuare richieste API all'API pubblica o membro.
Method: GET Accept: application/vnd.orcid+xml
Authorization type and Access token:
Bearer [Stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/record
L'API restituirà un messaggio 200 OK, indicando che la richiesta è stata ricevuta con successo, e il riepilogo completo del ORCID registrazione, compresi i riepiloghi dei singoli elementi.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0">
[...]
</record:record>
Ogni voce (lavoro, finanziamento, occupazione, ecc.) ha un metti il codice. Questo può essere utilizzato per ottenere tutti i dettagli dell'articolo, se necessario.
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.
Prima di poter aggiungere un elemento al ORCID record sarà necessario formattare i dati nel ORCID schema. Formatta i tuoi dati nel ORCID schema del messaggio in XML o JSON.
Il nostro repository GitHub contiene risorse che aiuteranno con la formattazione durante la creazione di nuovi elementi sul on ORCID record, e durante la lettura di elementi esistenti sul ORCID disco:
Notare che versioni diverse dell'API hanno formati di messaggio diversi. Sono disponibili anche schemi ed esempi della versione 2.0 e 2.1.
Altri esempi possono essere facilmente trovati leggendo i metadati di un record ben popolato.
Versione precedente del ORCID L'API aveva ambiti aggiuntivi. Questi ambiti sono stati eliminati gradualmente con l'API 2.0. Incoraggiamo tutte le integrazioni a utilizzare solo gli ambiti consigliati. Per riferimento, gli ambiti precedenti sono elencati di seguito con l'ambito corrente che dovrebbe essere utilizzato al suo posto
- /orcid-profilo/limitato in lettura usa invece /limitato in lettura
- /orcid-funziona/lettura-limitata usa invece /limitato in lettura
- /orcid-bio/limite di letturad usa invece /limitato in lettura
- /orcid-lavora/crea usa invece /attività/aggiornamento
- /orcid-funziona/aggiorna usa invece /attività/aggiornamento
- /affiliazioni/creare usa invece /attività/aggiornamento
- /affiliazioni/aggiornamento usa invece /attività/aggiornamento
- /finanziare/creare usa invece /attività/aggiornamento
- /funding/update usa invece /activities/update
- /orcid-bio/aggiornamento usa invece /persona/aggiornamento
- /orcid-bio/identificatori-esterni/crea usa invece /persona/aggiornamento
I token di aggiornamento vengono utilizzati per generare token di accesso aggiuntivi. Un token di aggiornamento viene restituito con il token di accesso quando si scambia un codice di autorizzazione come parte del processi OAuth a tre vie, e può essere utilizzato finché il token di accesso rimane attivo.
I nuovi token di accesso possono avere la stessa scadenza e gli stessi ambiti del token di accesso originale o possono essere specificati per avere una durata più breve e un sottoinsieme più piccolo di ambiti dal token di accesso originale. Possono essere generati nuovi token di accesso per sostituire il token originale o generati per fungere da token aggiuntivo. È inoltre possibile utilizzare le chiamate del token di aggiornamento per far scadere completamente l'accesso originale e aggiornare i token e qualsiasi autorizzazione concessa dall'utente.
Suggeriamo di utilizzare i token di aggiornamento nelle seguenti condizioni:
- Sostituzione dei token di accesso che potrebbero essere stati compromessi (assicurati di revocare il token di accesso originale dopo)
- Dare a una terza parte che è anche parte tua ORCID integrazione accesso più limitato e/o accesso per un tempo limitato.
Si prega di fare riferimento al nostro documentazione tecnica su come creare nuovi token di accesso dai token di aggiornamento.
Ci sono due diversi ambiti di aggiornamento: uno per i dettagli biografici, l'altro per le attività.
Obbiettivo | Descrizione | Endpoint API |
/persona/aggiornamento | Dati biografici-la colonna di sinistra del ORCID registrare l'interfaccia utente. | /indirizzo /identificatori-esterni /parole chiave /altri nomi /URL-ricercatore |
/attività/aggiornamento | Dati dell'attività di ricerca: la colonna di destra del file ORCID registrare l'interfaccia utente. | /distinzione /distinzioni /formazione scolastica /educazioni /occupazione /occupazioni /finanziamento /finanziamenti /posizione-invitata /posizioni-invitate /appartenenza /abbonamenti /revisione tra pari /revisioni dei pari /qualificazione /titoli di studio /risorsa-ricerca /risorse-di-ricerca /servizio /Servizi /lavoro /lavori |
Utilizza l'ID client, il segreto e il token attivo o il token di aggiornamento associato per revocare la coppia di token. Puoi revocare le coppie di token create sia nella versione a due gambe che processi OAuth a tre vie. Se si dispone di più set di token, ad esempio per ambiti diversi, verranno revocati solo il token di accesso specificato e il token di aggiornamento corrispondente.
Suggeriamo di revocare i token nelle seguenti condizioni:
- Revocare i token emessi a un fornitore terzo dopo la cessazione di un rapporto;
- Per revocare i token quando gli utenti disconnettono i propri ORCID iD dal tuo sistema;
- Per consentire agli utenti di revocare i token dal tuo sistema.
Si consiglia di utilizzare il aggiorna i token per limitare l'ambito o la durata di un token di accesso esistente o aggiornare un token se è stato compromesso.
La revoca della chiamata API
https://sandbox.orcid.org/oauth/revoke (or https://orcid.org/oauth/revoke)
METHOD: POST
HEADER: accept:application/json
CONTENT-TYPE: application/x-www-form-urlencoded
DATA:
client_id=[Your client ID]
client_secret=[Your client secret]
token=[access token or refresh token for token pair to be revoked]
Tutti gli articoli (a parte il testo della biografia) su an ORCID il record ha un metti il codice:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<record:record path="/0000-0001-2345-6789" xmlns:internal="https://www.orcid.org/ns/internal" [...]>
<funding:funding-summary put-code="4413" path="/0000-0001-2345-6789/funding/4413" visibility="public" display-index="0"> [...]
</record:record>
Questo codice put può essere utilizzato per effettuare una chiamata all'API per recuperare i dati completi per un elemento. I seguenti elementi possono essere interrogati utilizzando a metti il codice:
endpoint | Descrizione |
/indirizzo/[inserisci codice] | Un singolo paese o regione |
/biografia | Il campo biografia: un'area di testo libera che solo il ricercatore può modificare |
/educazione/[inserisci codice] | Un elemento di affiliazione all'istruzione individuale |
/email/[inserisci codice] | Un indirizzo email individuale associato al record |
/occupazione/[inserisci codice] | Un elemento di affiliazione lavorativa individuale |
/identificatore-esterno/[inserisci codice] | Un identificatore esterno collegato individuale in un altro sistema |
/finanziamento/[inserisci codice] | Un'attività di finanziamento individuale |
/parole chiave/[inserisci codice] | Una singola parola chiave relativa al ricercatore e al suo lavoro |
/altri-nomi/[inserisci il codice] | Un nome aggiuntivo individuale con il quale il ricercatore è conosciuto |
/peer-review/[inserisci codice] | Un'attività di peer review individuale |
/URL-ricercatore/[inserisci il codice] | Un collegamento esterno individuale alla pagina personale o al profilo del ricercatore |
/lavoro/[inserisci codice] | Un lavoro di ricerca individuale |
/funziona/[inserisci codice1],[inserisci codice2],[inserisci codice3] | Lavori di ricerca individuale in blocco (fino a 100) |
Utilizzando l'endpoint della sezione e il codice put, puoi chiamare l'API utilizzando lo stesso token di accesso per ottenere l'intero elemento specifico. Questa chiamata di esempio recupera l'elemento di finanziamento completo 4413 in formato XML utilizzando l'API membro sul server sandbox.
Method: GET Accept: application/vnd.orcid+xml Authorization type and Access token: Bearer [stored access token]URI: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/funding/4413
L'API restituirà un messaggio 200 OK per indicare che il messaggio è stato ricevuto correttamente e restituirà l'XML completo dell'elemento di finanziamento:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<funding:funding put-code="4413" path="/0000-0002-9227-8514/funding/4413" visibility="public" [...] >
[...]
</funding:funding>
È possibile controllare il fonte di un elemento quando lo leggi se vuoi sapere chi lo ha aggiunto.
Un elenco di codici di errore API comuni, i loro possibili significati e suggerimenti su come risolverli è disponibile all'interno del nostro documentazione tecnica.
Se non riesci a risolvere il problema che stai riscontrando, faccelo sapere.
ORCID i membri possono aggiornare le informazioni che hanno precedentemente aggiunto a un ORCID disco. È possibile aggiornare un solo elemento alla volta e può essere aggiornato solo utilizzando le credenziali del client che lo hanno creato in primo luogo.
Per facilitare l'aggiornamento, assicurati di memorizzare il codice put e il token di accesso durante la creazione di oggetti.
Formatta l'elemento aggiornato in ORCID schema del messaggio con le informazioni modificate e includere le informazioni memorizzate metti il codice.
<?xml version="1.0" encoding="UTF-8"?> <employment:employment put-code="739288" [...]> [...] </employment:employment>
Chiama l'API:
Method: PUT Content-type: application/vnd.orcid+xml or application/vnd.orcid+jsonnAuthorization type and Access token: Bearer [stored access token]Data: link to file or text of affiliation to update URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
L'API restituirà un messaggio 200 OK per indicare che l'elemento è stato aggiornato correttamente. Controlla la nostra pagina di risoluzione dei problemi se viene restituito un messaggio diverso.
Visibilità indica l'impostazione della privacy dell'elemento, in base alla preferenza di visibilità impostata dall'utente. Se viene incluso un tag di visibilità quando le informazioni vengono pubblicate tramite l'API, verrà ignorato. Piuttosto, le informazioni verranno pubblicate in base alla preferenza di visibilità predefinita dell'utente come impostata nelle preferenze dell'account.
Gli elementi pubblici possono essere letti da chiunque tramite l'API e vengono mostrati nel registro pubblico del ricercatore, gli elementi delle parti attendibili vengono restituiti tramite l'API solo ai clienti con accesso limitato in lettura; non sono nel registro pubblico del ricercatore. Gli elementi privati sono visibili solo al ricercatore e alla fonte dell'elemento: gli unici elementi privati restituiti tramite l'API sono quelli che sono stati aggiunti al record tramite l'integrazione Maggiori informazioni sulle impostazioni di visibilità in ORCID registro.
Gli elementi (lavori, occupazione, finanziamenti, revisione paritaria, ecc.) possono essere aggiunti a un ORCID registrare utilizzando il ORCID API membro. Per fare questo, devi prima ottenere il permesso dal ricercatore utilizzando OAuth o formattare i metadati dell'elemento usando il ORCID schema del messaggio.
Dopo aver formattato i dati e raccolto il file ORCID iD e token di accesso, si effettua una richiesta API utilizzando HTTP POST, specificando il endpoint rilevante.
Method: POST
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]data: link to file or text of single employment item to add
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment
La chiamata qui sotto aggiunge una nuova occupazione affiliazione a un record sul server di test sandbox:
<?xml version="1.0" encoding="UTF-8"?>
<employment:employment [...]>
[...]
</employment:employment>
L'API restituirà un messaggio 201 per indicare che l'articolo è stato pubblicato correttamente, insieme all'articolo metti il codice. Il tuo cliente sarà elencato come il fonte dell'articolo.
Vai alla la risoluzione dei problemi pagina se viene restituito un messaggio diverso. Dovrai salvare il memorizzare il codice put e il token di accesso per apportare eventuali aggiornamenti o rimuovere l'elemento.
La ORCID l'API di ricerca utilizza la sintassi SOLR. Sono supportate tutte le sintassi di query disponibili in SOLR 3.6, incluso Lucene con estensioni Solr (Default), DisMax e Dismax esteso.
Hai bisogno di un token di accesso "/read-public" per usarlo. Una volta ottenuto il token di ricerca, crea il tuo URL di ricerca di base:
Tipo di credenziali: | API pubblica | API membro |
URL risorsa: | Sandbox: https://pub.sandbox.orcid.org Produzione: https://pub.orcid.org | Sandbox: https://api.sandbox.orcid.org Produzione: https://api.orcid.org |
Versione dell'API: | v3.0 | |
Endpoint di ricerca | /ricerca/?=[ricerca] |
Un esempio di chiamata per cercare "orcid” con il token sull'API pubblica sandbox con i risultati restituiti in formato XML è:
Method: GET Content-type: application/vnd.orcid+xmlnAuthorization type and Access token: Bearer [stored access token]URL: https://pub.sandbox.orcid.org/v3.0/search/?q=orcid
I risultati specificheranno il numero di risultati trovati (num-found) e visualizzeranno i primi 1000 risultati per impostazione predefinita:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<search:search num-found="385" xmlns:search="https://www.orcid.org/ns/search" xmlns:common="https://www.orcid.org/ns/common">
<search:result>
<common:orcid-identifier>
<common:uri>https://sandbox.orcid.org/0000-0001-2345-6789</common:uri>
<common:path>/0000-0001-2345-6789</common:path>
<common:host>sandbox.orcid.org</common:host>
</common:orcid-identifier>
</search:result>
[...]
</search:search>
Un esempio di ricerca di base sull'API pubblica sandbox con risultati restituiti in formato json:
Method: GET
Content-type: application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.sandbox.orcid.org/v3.0/search/?q=newman
La ricerca restituisce solo l'individuo ORCID ID di record contenenti dati pubblici corrispondenti alla ricerca. Per avere maggiori informazioni sul risultato telefonare per leggere il ORCID registrare direttamente.
Per ulteriori informazioni, consultare il nostro Esercitazione sull'API di ricerca.
Se hai aggiunto dati che devono essere eliminati, ad esempio, se sono stati associati a un errore ORCID iD, quindi puoi effettuare una richiesta DELETE HTTP specificando il endpoint pertinente, insieme con il ORCID ID, token di accesso memorizzato e codice put memorizzato. È possibile eliminare solo un elemento alla volta e puoi eliminare solo gli elementi aggiunti dal tuo cliente. È possibile eliminare elementi anche quando l'utente ha revocato l'autorizzazione.
Questa chiamata di esempio elimina l'elemento di occupazione con il codice put "739288" da un record"
Method: DELETE
Content-type: application/vnd.orcid+xml or application/vnd.orcid+json
Authorization type and Access token: Bearer [stored access token]
URL: https://api.sandbox.orcid.org/v3.0/[ORCID iD]/employment/739288
La ORCID l'API di ricerca utilizza la sintassi SOLR. Sono supportate tutte le sintassi di query disponibili in SOLR 3.6, incluso Lucene con estensioni Solr (Default), DisMax e Dismax esteso.
È possibile utilizzare una ricerca per campo quando è necessario cercare una sezione specifica del ORCID disco. L'elenco corrente dei campi riconosciuti nella ricerca API, insieme ai corrispondenti elementi della struttura dei record, è il seguente:
Campo di ricerca | Descrizione |
Dati biografici | |
nomi di battesimo | Il (nome) dato (i) dell'utente. |
cognome | Il cognome (cognome) dell'utente. |
nome-credito | Il “nome pubblicato” sul ORCID interfaccia utente, il nome che normalmente compare sulle pubblicazioni dall'utente |
altri nomi | Nomi alternativi che potrebbero essere apparsi sulle pubblicazioni dell'utente. |
L'indirizzo email dell'utente. | |
parola chiave | Qualsiasi parola chiave associata all'utente. |
riferimento-id-esterno | Identificatori da altri sistemi aggiunti a quelli dell'utente ORCID registrare utilizzando l'API. |
Dati di affiliazione | |
affiliazione-nome-organizzazione | Il nome di qualsiasi organizzazione in un elemento di istruzione o impiego nel record dell'utente. |
griglia-org-id | La ID GRIGLIA di qualsiasi organizzazione nella sezione attività del record dell'utente. Generalmente questo sarà associato a un elemento di istruzione o occupazione. |
id-ror-org | La ROR ID di qualsiasi organizzazione nella sezione attività del record dell'utente. Generalmente questo sarà associato a un elemento di istruzione o occupazione. |
ringgold-org-id | La ID anello oro* di qualsiasi organizzazione nella sezione attività dell'anagrafica dell'utente. Generalmente questo sarà associato a un elemento relativo all'istruzione o all'occupazione. |
Dati di finanziamento | |
titoli-finanziamenti | Il titolo di qualsiasi elemento di finanziamento nel record dell'utente. |
fundref-org-id | La ID registro finanziatori Crossref di qualsiasi organizzazione nella sezione delle attività del record di un utente. Generalmente questo sarà associato a un elemento di finanziamento, ma potrebbe anche essere associato a un'affiliazione. |
numeri di sovvenzione | Numero di concessione (identificatore) di qualsiasi elemento di finanziamento nel record dell'utente. |
Dati attività di ricerca | |
titoli-di-lavoro | I titoli di qualsiasi opera nel record dell'utente. |
ID-oggetti-digitali | Un identificatore esterno di lavoro di tipo doi |
fai da te | Un identificatore esterno di lavoro con tipo doi e la relazione dell'identificatore esterno impostata su self |
[tipo di identificatore esterno]* | Un identificatore esterno di lavoro con il tipo specificato |
[tipo di identificatore esterno]*-self | Un identificatore esterno di lavoro con il tipo dato e la relazione dell'identificatore esterno impostata su self |
[tipo di identificatore esterno]*-part-of | Un identificatore esterno dell'opera con il tipo dato e la relazione dell'identificatore esterno impostata su part-of |
[tipo di identificatore esterno]*-versione-di | Un identificatore esterno di lavoro con il tipo specificato e la relazione dell'identificatore esterno impostata su version-of * Per un elenco completo di identificatori esterni vedere il elenco di identificatori. Alcuni identificatori potrebbero richiedere "-self" "-part-of" o "-version-of" per restituire risultati |
ORCID registrare i dati | |
orcid | Le 16 cifre ORCID identificativo dell'utente, nel formato 0000-0001-2345-6789. |
data-invio-profilo | La data e l'ora in cui è stato creato il record. |
data-ultima-modifica-profilo | La data e l'ora dell'ultima modifica del record. |
Tutti i dati | |
testo | Tutti i campi sopra. Questo è anche il campo predefinito per le query di sintassi Lucene. |
vedere il nostro Esercitazione sull'API di ricerca per maggiori informazioni.
*Sebbene gli identificatori Ringgold esistano ancora all'interno del file ORCID registro, dal 1° agosto 2023, ORCID non riceverà più aggiornamenti al database degli identificatori dell'organizzazione RINGGOLD utilizzato dal nostro Registro, né saremo in grado di elaborare o utilizzare gli ID RINGGOLD creati dopo tale data. Vedi il nostro FAQ per maggiori informazioni
In situazioni reali, le interazioni API vengono completate dal tuo sistema utilizzando un linguaggio di programmazione come PHP, Java o Ruby on Rails. Per esercitarsi e testare, puoi interagire con il ORCID API che utilizzano una gamma di strumenti in grado di effettuare e ricevere richieste HTTP. La maggior parte degli strumenti HTTP desktop vengono eseguiti nella riga di comando; per chi preferisce un'interfaccia grafica, gli strumenti basati sul web sono un'utile alternativa.
VERIFICA XML/XSD
Ci sono molti strumenti che verificheranno il tuo XML per te; è una buona idea adottarne uno. Per molte delle chiamate API lavorerai con informazioni in formato XML. In particolare quando si lavora con il ORCID Messaggio API, sarà importante che l'XML che utilizzi sia valido per l'XSD. (Vedi il nostro documentazione su GitHub per l' ORCID schema del messaggio XSD.)
ORCID SERVER DI PROVA SANDBOX
La server di test sandbox è una copia di ORCID Software di registro e contiene solo dati di test. È stato progettato per fornire un posto dove provare le cose senza intaccare alcun reale ORCID iD, in particolare se stai lavorando con il ORCID API e hai bisogno di un posto dove testare il tuo lavoro. Puoi creare account utente e testare le chiamate API sulla sandbox senza doversi preoccupare di influire sui dati di produzione o inviare accidentalmente spam ai ricercatori.
Non hai nemmeno bisogno di essere un ORCID membro per provare l'API membro nella sandbox. Tutti sono invitati a richiedere le credenziali dell'API del membro sandbox e provare tutte le funzionalità disponibili per l'API del membro.
Il sito e le API non saranno affidabili come lo sono per i server di produzione. Non garantiamo i dati sulla sandbox; non vengono sottoposti a backup e possono essere eliminati. La sandbox può anche contenere alcune funzionalità sperimentali che non sono ancora sui server di produzione, quindi puoi provare le cose prima che esistano nel registro. Scopri di più sul server di test sandbox o richiedi le credenziali del cliente.
STRUMENTI HTTP
Sono disponibili molti strumenti per eseguire richieste HTTP. Alcuni che usiamo:
I webhook possono essere registrati dai membri premium contro qualsiasi ORCID registrare nel registro. I passaggi sono:
Codifica l'URL
Codifica URL l'URL che desideri ORCID da chiamare quando il record dell'utente viene aggiornato. Ad esempio il seguente URL:
https://nowhere2.com/0000-0002-7465-2162/updated
diventa
https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Costruisci l'URL
Crea l'URL completo per il for ORCID Chiamata API che inizia con l'URL del ORCID record quindi aggiungendo ‚√∫/webhook‚√π e l'URL che vuoi chiamare. Quindi dovrebbe assomigliare a https://api.sandbox.orcid.org/{ORCID}/webhook/{URL-CODIFICATO-WEBHOOK-URL}
Ad esempio, utilizzando l'URL del webhook sopra e il ORCID iD 0000-0002-7465-2162, l'URL completo è:
https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
Registra il webhook
Usa il tuo webhook‚ token di accesso per registrare il tuo webhook rispetto a quello dell'utente ORCID disco. Devi utilizzare una richiesta HTTP PUT, ma non dovresti includere nulla nel corpo della richiesta.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdatedn HEADER: Accept: application/json HEADER: Authorization: Bearer [Your access token]n HEADER: Content-Length: 0n METHOD: PUT
La risposta dovrebbe essere 201, ma se la richiamata esisteva già, la risposta sarà 204.
HTTP/1.1 201nServer: nginx/1.1.19nConnection: keep-alive Location: https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Frequestb.in%2Fz57lzcz5
L'URL per annullare la registrazione di un webhook è lo stesso della registrazione. Tuttavia, è necessario utilizzare il metodo DELETE HTTP.
URL= https://api.sandbox.orcid.org/0000-0002-7465-2162/webhook/https%3A%2F%2Fnowhere2.com%2F0000-0002-7465-2162%2Fupdated
HEADER: Authorization: Bearer [Your access token]
HEADER: Content-Length: 0
METHOD: DELETE
La risposta dovrebbe essere 204 No Content
.
HTTP/1.1 204 No Content
Server: Apache-Coyote/1.1
Date: Fri, 05 Apr 2013 12:49:17 GMT
La ORCID Il registro eseguirà la seguente chiamata HTTP quando un record viene aggiornato. La richiesta utilizza il metodo HTTP POST, ma il corpo della richiesta è vuoto.
curl -v -X POST https://nowhere2.com/0000-0002-7253-3645/updated
Il tuo server dovrebbe rispondere con codici di risposta HTTP standard. Quindi, se la chiamata è andata a buon fine, dovresti restituire 204 No Content.
HTTP/1.1 204 No Content
Qualsiasi codice di risposta 2xx indica che la chiamata è andata a buon fine. Se restituisci un codice che non è un 2xx, riproveremo la chiamata cinque minuti dopo.
In situazioni reali, le interazioni API vengono completate dal tuo sistema utilizzando un linguaggio di programmazione come PHP, Java o Ruby on Rails. Per esercitarsi e testare, invece, è possibile interagire con il ORCID API che utilizza una gamma di strumenti in grado di effettuare e ricevere richieste HTTP. La maggior parte degli strumenti HTTP desktop (come cURL) vengono eseguiti nella riga di comando; per chi preferisce un'interfaccia grafica, gli strumenti basati sul web sono un'utile alternativa.
Uno strumento popolare è Parco giochi OAuth 2.0 di Google, uno strumento gratuito basato sul Web sviluppato e gestito da Google.
Si prega di vedere il nostro tutorial sull'API all'indirizzo: https://info.orcid.org/hands-on-with-the-orcid-api/
Nota: ORCID non mantiene l'OAuth 2.0 Playground: questo strumento è stato creato da Google, che ne mantiene esclusivamente il codice. Sebbene aggiorniamo periodicamente questa documentazione, di tanto in tanto potrebbero esserci alcune imprecisioni, poiché potremmo non essere immediatamente a conoscenza delle modifiche a OAuth 2.0 Playground.
Per la nostra versione API 2.0 e superiori i limiti sono:
- Richiedi un secondo – 24
- Scoppio – 40
Richiedi un secondo – Numero di richieste che possono essere effettuate al secondo.
Burst – Numero di richieste che consentiremo di essere accodate prima di essere rifiutate. Le richieste in coda vengono rallentate alla velocità delle richieste al secondo. Se superi il burst, otterrai una risposta 503.
Se riscontri problemi con i limiti, contatta il responsabile del team di coinvolgimento per assistenza.
Il controllo del ricercatore è fondamentale is ORCID principio quindi gli indirizzi e-mail registrati e aggiunti al file ORCID record sono, per impostazione predefinita, impostati come visibili solo al detentore del record. Le e-mail non verificate non vengono visualizzate nella visualizzazione pubblica del record e solo gli indirizzi e-mail che sono stati verificati verranno visualizzati nei risultati dell'API.
Una volta che i ricercatori hanno verificato il loro indirizzo e-mail, devono scegliere di renderlo visibile a tutti (ad es. pubblico) oa parti fidate (ad es. accesso limitato) in modo che l'indirizzo e-mail possa essere letto da organizzazioni terze.
Se il ricercatore ha impostato il proprio indirizzo e-mail su parti attendibili, verrà restituito con il record se il ricercatore ti ha concesso accesso limitato in lettura. Per ulteriori informazioni, vedere ORCID impostazioni di visibilità.
L'API 3.0 è la versione API predefinita e ti consigliamo di utilizzare questa versione quando crei nuove integrazioni. Continueremo a supportare API 2.0 e 2.1 per il prossimo futuro e forniremo un preavviso di almeno 12 mesi prima di disattivare tali versioni.
Abbiamo imparato molto durante la transizione dall'API 1.2 all'API 2. Questa volta abbiamo reso l'aggiornamento molto più semplice da gestire. L'API 3.0 aggiunge nuove funzionalità modificando solo le funzionalità esistenti quando assolutamente necessario. Ciò significa che gli integratori dovrebbero essere in grado di passare alla nuova API con il minimo sforzo. Significa anche che, sebbene ti consigliamo di iniziare a pianificare il tuo aggiornamento il prima possibile in modo che la tua organizzazione e i tuoi ricercatori possano beneficiare delle nuove funzionalità, hai molta flessibilità nel decidere quando aggiornare alla 3.0.
Il piccolo elenco di modifiche potenzialmente importanti si trova nelle nostre note sulla versione dell'API qui o qui. Ci sono alcune modifiche ai campi facoltativi/obbligatori, le enumerazioni JSON sono state leggermente modificate e abbiamo anche un piccolo refactoring dei nostri schemi XML, aggiungendo alcuni nuovi campi per contenere i metadati richiesti per la nuova funzionalità.
Si prega di consultare la ORCID pagina dei sistemi abilitati dal fornitore per gli editori per le informazioni più aggiornate
Tutti i membri premium possono ottenere un token di accesso "/webhook". È possibile utilizzare un singolo token per registrare webhook per più record. Per ottenere un token, si effettua una chiamata al ORCID Endpoint del token API.
Questo processo viene spesso definito flusso OAuth delle credenziali client o OAuth in due passaggi.
Di seguito è riportato un esempio di chiamata per ottenere il token di accesso: sostituisci i segnaposto con le tue credenziali (assicurati di rimuovere le parentesi).
curl -i -L -H "Accept: application/json"
-d "client_id=(your client ID)"
-d "client_secret=(your client secret)"
-d "scope=/webhook"
-d "grant_type=client_credentials"
"https://sandbox.orcid.org/oauth/token"
Ti verrà quindi restituito un token di accesso simile al seguente.
{"access_token":"5eb23750-1e19-47a3-b6f6-26635c34e8ee",
"token_type":"bearer",
"refresh_token":"c7d3d5fd-e4c0-4825-89f2-7cfb4a1cf01e",
"expires_in":631138518,
"scope":"/webhook"}
Sì, lo facciamo! Puoi leggere di più sul nostro versionamento delle API, la logica alla base e altro ancora, qui su nostro Politica sulla versione dell'API.
Mentre continuiamo a sviluppare i nostri prodotti, ci sono una serie di funzionalità che sono disponibili solo con l'API 3.0, che è la nostra versione API più recente e predefinita.
La tabella seguente fornisce una breve descrizione di ciascuna funzione. In caso di domande su una qualsiasi delle funzionalità o sull'aggiornamento alla versione 3.0, contattare il responsabile dell'impegno o il responsabile del consorzio.
Possibilità di leggere e scrivere tutti i tipi di affiliazione (appartenenza, servizio, posizioni invitate, distinzioni e qualifiche non disponibili con le versioni precedenti dell'API) |
Capacità di leggere e scrivere risorse di ricerca. |
Capacità di leggere e scrivere identificatori di lavoro con tipo di relazione "Finanziato da". Viene utilizzato per collegare gli ID concessione o proposta ai metadati di lavoro. |
Capacità di leggere e scrivere identificatori di lavoro con il tipo di relazione "Versione di". Questo è usato per collegare altre versioni del lavoro insieme. Un caso d'uso di esempio sarebbe il collegamento della prestampa e dell'articolo pubblicato. |
Capacità di leggere e scrivere ruoli CRediT all'interno dei metadati delle opere. |
Possibilità di leggere i campi sorgente aggiuntivi comune: affermazione-origine-id-client o comune:asserzione-origine-nome per le affiliazioni aggiunte dal ORCID portale dei membri e opere aggiunte dalla ricerca e dai collegamenti guidati. |
Capacità di leggere e scrivere opere con tipo di lavoro di: annotazione piani-di-gestione-dati tesi di laurea preprint oggetto-fisico recensioni |
Capacità di leggere e scrivere ID esterni per le affiliazioni. |
Gli ID dell'organizzazione sono obbligatori per aggiungere affiliazioni e finanziamenti a and ORCID Records. |
Formalizzazione degli identificatori: abbiamo introdotto un nuovo campo generato dal sistema, che esprime identificatori esterni (DOI, PMCID, PMID, ArXiv, Bibcode, ISSN e ISBN) in un formato normalizzato ai fini della corrispondenza e del raggruppamento. La normalizzazione viene eseguita in base alle regole del tipo di identificatore e può includere l'impostazione di tutti i caratteri alfabetici in minuscolo o la trasformazione di spazi, trattini, punti e altri caratteri che possono essere considerati equivalenti. Aggiunge inoltre prefissi e suffissi standard a seconda dei casi. Per esempio, https://doi.org/10.1/123, 10.1/123e https://dx.doi.org/10.1/123 appariranno tutti in questo campo come https://doi.org/10.1/123. Il valore dell'identificatore esistente non è modificato. |
Informazioni più dettagliate possono essere trovate qui.
Altro
Ricevono una notifica nel loro ORCID Posta in arrivo. Ogni volta che c'è un cambiamento nei dati su un ORCID record, l'utente riceve una notifica con le informazioni di base sulla modifica, incluso il nome del cliente che esegue l'aggiornamento, la data della modifica e l'elemento nel ORCID record che è stato aggiornato. Guarda il nostro User Knowledge Base per ulteriori informazioni sulle notifiche.

ORCID anche i record sulla sandbox hanno caselle di posta funzionanti. Ti consigliamo di controllare regolarmente le caselle di posta dei tuoi test ORCID record durante la pianificazione del modo in cui i sistemi pianificheranno gli aggiornamenti dei dati.
Aggiornamenti e altri annunci per gli utenti API sono condivisi tramite il ORCID Gruppo utenti API. Puoi anche iscriverti a messaggi generali e aggiornamenti tramite il ORCID Blog.
ORCID i membri ricevono anche il ORCID Newsletter per i membri in cui sono incluse queste informazioni. Infine, il contatto tecnico per qualsiasi ORCID membro con un'integrazione attiva e personalizzata riceverà anche messaggi di posta elettronica su eventuali aggiornamenti critici per il ORCID Registro. Se desideri essere elencato come contatto tecnico per la tua organizzazione, per favore CONTATTACI.
ORCID si impegna ad essere aperto e trasparente. Questo significa che il nostro roadmap del prodotto è disponibile per la visualizzazione da parte di chiunque, così come il lavoro attualmente in fase di sviluppo.
La Roadmap del prodotto è fondamentale per il ORCID processo di sviluppo del prodotto. I requisiti viaggiano dalle schede trello gestite dal team, attraverso la scheda trello Product Roadmap e poi fino alla scheda trello Sviluppo attuale, dove vengono implementati e trasferiti ai nostri sistemi di produzione.
Questa scheda contiene requisiti ben definiti di cui è prevista l'implementazione ad un certo puntoe un elenco di requisiti prioritari previsti per l'attuazione a breve termine.
Da dove vengono i requisiti?

I requisiti sono raccolti da molte fonti da ORCID personale. Possono provenire da richieste dei membri, feedback del consorzio, test degli utenti, progetti strategici e segnalazioni di bug, tra gli altri. Inoltre, tutto ORCID i team generano i propri requisiti interni, come modifiche al sito Web, aggiornamenti dell'infrastruttura e aggiornamenti dei sistemi operativi. Ogni scheda è etichettata con il team che ha prodotto il requisito: comunicazioni, strategia, tecnologia, coinvolgimento o operazioni.
Come vanno le cose sulla tabella di marcia?
ORCID mira a un ciclo di sviluppo del prodotto equilibrato e tiene riunioni regolari tra i team per discutere le priorità a breve e lungo termine. Facciamo del nostro meglio per risolvere allo stesso modo bug, nuove funzionalità, debiti tecnici, aggiornamenti del sito Web e elementi strategici.
Come posso contribuire alla roadmap?
Accettiamo suggerimenti su come migliorare il ORCID registro. Si prega di inviare qualsiasi feedback a il nostro team.
Inoltre, ORCID è un progetto open-source e diamo il benvenuto a contributi al nostro codice sorgente così come a tutti i nostri repository.
Una prestampa è un manoscritto scientifico completo che viene caricato dagli autori su un server pubblico. Il preprint contiene dati e metodologie completi; spesso è lo stesso manoscritto che viene inviato a una rivista. Dopo una breve ispezione di controllo della qualità per garantire che il lavoro sia di natura scientifica, il manoscritto dell'autore viene pubblicato entro un giorno circa sul Web senza peer review e può essere visualizzato gratuitamente da chiunque nel mondo. Sulla base del feedback e/o di nuovi dati, è possibile inviare nuove versioni del preprint; tuttavia, vengono mantenute anche le versioni prestampate precedenti. I server di prestampa consentono agli scienziati di controllare direttamente la diffusione del loro lavoro alla comunità scientifica mondiale. Nella maggior parte dei casi, lo stesso lavoro pubblicato come prestampa viene anche inviato per la revisione tra pari a una rivista. Pertanto, le preprint (rapide, ma non convalidate tramite peer-review) e la pubblicazione su rivista (lenta, ma che fornisce la convalida tramite peer-review) funzionano in parallelo come sistema di comunicazione per la ricerca scientifica.
Nota: questo contenuto e questo video sono apparsi originariamente su Sito web ASAPBio Grazie ad ASAPBio per averlo reso disponibile con una Licenza CC-BY!
La newsletter dei membri inviata mensilmente da ORCID in precedenza conteneva un collegamento a una cartella di Google Drive in cui erano archiviati tutti i rapporti sui membri. Questo è stato ora sostituito con nuovi rapporti disponibili per tutti i membri nel portale membri.
Rapporti precedenti:
- Membri Premium con integrazioni attive ricevere un collegamento univoco a una cartella contenente report separati e personalizzati con i dati per ogni integrazione nel mese precedente.
- Membri Premium che non hanno ancora un'integrazione attiva ricevere un collegamento univoco a una cartella contenente report personalizzati con statistiche e-mail per il proprio istituto, nonché un collegamento a una cartella che contiene report generali con dati aggregati per tutte le integrazioni dei membri attivi.
- Membri di base ricevere un link a una cartella contenente i report generali emessi due volte l'anno con i dati aggregati per tutte le integrazioni di membri attivi nel semestre precedente; la relazione semestrale è pubblicata in Luglio (dati gennaio-giugno), il rapporto del secondo semestre pubblicato in Gennaio (luglio-dicembre dell'anno successivo).
Se sei un ORCID membro e al momento non ricevi la newsletter mensile per i membri, contatta support@orcid.org
Membri Premium con integrazioni attive
La cartella Google Drive contiene un rapporto sui membri per ciascuno degli iD client di produzione emessi per te. I nomi dei file includono il nome visualizzato del client iD e la data della relazione; ordina per data di modifica per trovare il rapporto più recente. Esiste anche una cartella raw_data contenente i dati utilizzati per generare il report, disponibile per ulteriori analisi se necessario.
Membri Premium che non hanno ancora un'integrazione attiva
La cartella Google Drive contiene un rapporto sui membri con solo dati statistici e-mail, nonché un collegamento a una cartella Google Drive di rapporti mensili generali con dati aggregati per tutte le integrazioni dei membri attivi, per l'anno in corso e precedenti. I dati grezzi non sono disponibili per questi rapporti.
Conteggio del dominio di posta elettronica
Questa sezione fornisce i conteggi di ORCID iDs ha attualmente registrato i domini e-mail del tuo istituto in tutti i periodi di tempo. Per generare questi conteggi, cerchiamo i domini che corrispondono all'URL del sito web che abbiamo in archivio per la tua organizzazione (es: se l'URL del tuo sito web è www.universitycollege.edu, cerchiamo le email che terminano con @universitycollege). Se non abbiamo un URL del sito web in archivio, vedrai ‚√∫Nessun dominio email fornito‚√π in questa sezione. Se non abbiamo ottenuto correttamente il tuo dominio e-mail o se desideri aggiungere altri domini, ti preghiamo di CONTATTACI.
- Record registrati nei tuoi domini di posta elettronica¬¨‚Conteggio unico ORCID iD che includono un indirizzo all'interno dei domini e-mail del tuo istituto
- Record registrati ai tuoi domini di posta elettronica E associati al tuo ID cliente¬¨‚Conteggio unico ORCID ID che includono un indirizzo all'interno dei domini e-mail del tuo istituto E che includono il tuo istituto come Parte attendibile (ovvero: record per i quali il tuo istituto ha un token di accesso valido)
Record creati e rivendicati
(Nota: la maggior parte dei clienti non avrà questa sezione nei propri rapporti)
Se hai un cliente istituzionale che è stato utilizzato per creare record per conto dei ricercatori tramite l'API, riceverai una sezione chiamata Statistiche del Registro. Ciò include informazioni sul numero di record creati e quanti ne sono stati rivendicati (il file raw_data contiene ulteriori informazioni sui record specifici utilizzati per generare questi numeri).
Utenti
Questa sezione del rapporto contiene un conteggio totale del numero di ricercatori che hanno utilizzato la tua integrazione per collegare i loro ORCID iD al tuo sistema durante il mese di reporting. Inoltre, fornisce il numero totale di quei ricercatori che si sono iscritti a un nuovo ORCID iD come parte del iD processo di connessione.
Il grafico denominato Eventi di integrazione totale mostra il numero di ricercatori che hanno utilizzato la tua integrazione nell'ultimo mese, per giorno
Eventi
Il rapporto contiene anche eventi informazioni, le azioni che il ricercatore ha compiuto nel collegare i propri ORCID registrare con il proprio sistema nel mese di rendicontazione. Ogni evento rappresenta qualsiasi accesso concesso dall'utente o azione che ha fatto sul ORCID sito (come l'accesso o l'accesso con limitazione di lettura). Alla maggior parte dei ricercatori sarà associato più di un evento.
Se a un evento è aggiunto un ‚√∫√π, ciò significa che il ricercatore ha concesso un longevo (Ppersistente) rispetto a un token di breve durata che scade in un'ora. Da marzo 2018, solo i token di lunga durata sono supportati su ORCID Anagrafe; il tuo sistema integrato o l'utente può scegliere di revocare il token in qualsiasi momento.
Utenti per paese
La sezione finale dei report contiene le informazioni sui ricercatori che hanno utilizzato la tua integrazione suddivise per Paese da cui hanno avuto accesso alla tua integrazione. Questi dati derivano dall'indirizzo IP di un ricercatore o dalla sua area geografica ID (a sua volta determinato da Google dall'indirizzo IP del ricercatore).
Campionamento
Perché così tanti ricercatori usano il ORCID Registro, non è possibile eseguire report sull'intero set di dati del ricercatore. Invece i numeri forniti qui sono prodotti utilizzando le tendenze da un insieme campionato e non campionato. Le sezioni del report derivate dai dati campionati sono contrassegnate da un asterisco e la dimensione e lo spazio campionati sono specificati nella scheda Dati analitici. I numeri nella sezione Google Analytics del rapporto potrebbero non corrispondere interamente alle statistiche locali conservate e potrebbero esserci piccole discrepanze nel conteggio tra le sezioni del rapporto.
I parametri di campionamento elencati sotto Analisi integrazione si applicano a tutte le sezioni contrassegnate da un asterisco. La percentuale di sessioni catturate dai dati di analisi è (dimensione del campione)/(spazio del campione) * 100%. Ulteriori informazioni sul campionamento sono disponibili all'indirizzo Google sviluppatori.
Rapporti vuoti
Le sezioni Utenti ed Eventi del rapporto includono solo i dati del mese scorso. Se nessun ricercatore ha utilizzato la tua integrazione nell'ultimo mese, nessun dato verrà restituito.
Domande
In caso di domande sui rapporti dei membri, per favore CONTATTACI.
La ORCID Il registro è progettato per consentire agli utenti di fornire i propri ID alle organizzazioni che utilizzano OAuth, il che garantisce che il corretto iD viene raccolto per ogni ricercatore. Scoraggiamo le organizzazioni dall'aggiungere ORCID iD ai loro sistemi basati su una ricerca di ricercatori per nome. Tuttavia, può essere utile scoprire quanti ricercatori hanno nella tua organizzazione ORCID iD, che possono essere eseguiti tramite l'API. Di seguito vengono forniti suggerimenti per la ricerca per organizzazione.
Per un'introduzione alla ricerca, come ottenere un token di accesso, come comprendere i risultati della ricerca e i dettagli di altri campi in cui è possibile eseguire la ricerca, consultare il nostro Esercitazione sulla ricerca dell'API del registro
Ricerca per nome e DOI
Quando si controlla se un individuo ha un has ORCID record, consigliamo di cercare sia per nome che per DOI di uno o più dei loro lavori recenti. Ciò dovrebbe comportare solo il record del ricercatore che stai cercando e non i record di chiunque altro condivida lo stesso nome.
Un esempio di chiamata per cercare tutti i record con il nome "Laurel Haak" e il DOI 10.1087/20120404 o il DOI 10.6084/M9.FIGSHARE.1115124:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search?q=family-name:Haak+AND+given-names:Laurel+AND+digital-object-ids:%2210.1087/20120404%22+OR+digital-object-ids:%2210.6084/M9.FIGSHARE.1115124’%22
Ricerca per affiliazione
I campi di affiliazione possono essere cercati utilizzando il nome dell'affiliazione o il ROR univoco dell'organizzazione ID o ID GRIGLIA. (Puoi trovare il GRID della tua organizzazione ID in GRID o il tuo ROR ID nel Registro ROR)
Cerca per nome dell'organizzazione
Method: GET Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:"University+of+Johannesburg"
O per una corrispondenza esatta
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=affiliation-org-name:(%22Boston%20University%22)
Ricerca per ID GRIGLIA
Un esempio di chiamata per cercare tutti i record con il GRID ID grid.5509.9 (Università di Tampere):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=grid-org-id:grid.5509.9
Ricerca per ID ROR
Un esempio di chiamata per cercare tutti i record con l'ID ROR 04fa4r544 (ORCID):
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=ror-org-id:"https://ror.org/04fa4r544"
Cerca per dominio di posta elettronica
Puoi utilizzare l'API per cercare ricercatori per dominio di posta elettronica. Tieni presente che circa il 97% degli indirizzi email in ORCID sono privati e tutti i record con un indirizzo e-mail privato o con accesso sicuro non verranno restituiti in questa ricerca.
Un esempio di chiamata per cercare tutti i record con @orcidIndirizzo e-mail .org:
Method: GET
Content-type: application/vnd.orcid+xml
Authorization type and Access token: Bearer [stored access token]
URL: https://pub.orcid.org/v3.0/search/?q=email:*@orcid.org
Risultati della ricerca restituiti in formato CSV
I risultati della ricerca possono essere restituiti anche in formato CSV. Come parte della chiamata è possibile specificare le colonne di output da un elenco di campi disponibili di seguito:
orcid
email
nome di battesimo
cognome
dati-e-cognomi
nome-credito
altro nome
nome-affiliazione-istituto-attuale
nome-affiliazione-istituto-passato
Utilizzando le tue credenziali è necessario specificare l'intestazione come "testo/csv'. Come parte della chiamata di ricerca, è necessario aggiungere alla query anche i campi richiesti nell'output.
Ricerca usando solo il tuo browser
Puoi anche completare la ricerca utilizzando il tuo browser. L'URL è costruito allo stesso modo, ma non è necessario utilizzare alcuna credenziale API. Si prega di notare che questo può essere completato solo utilizzando l'API pubblica.
Di seguito è riportato un esempio di chiamata utilizzando l'API pubblica che effettua la ricerca per nome dell'organizzazione con ORCID, nomi, cognomi, nome di affiliazione dell'istituto attuale e nome di affiliazione dell'istituto passato come output desiderato.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:ORCID&fl=orcid,given-names,family-name,current-institution-affiliation-name,past-institution-affiliation-name
Di seguito è riportato un altro esempio di chiamata che utilizza l'API pubblica che esegue la ricerca in base a diverse varianti del nome dell'organizzazione.
https://pub.orcid.org/v3.0/csv-search/?q=affiliation-org-name:("University of Plymouth" OR "Plymouth University")
Lo schema eduPerson ha aggiunto il eduPersonaOrcid attributo nella sua Aggiornamento 2016 di febbraio.
Come per il Specifiche eduPerson:
RFC4512 definition
( 1.3.6.1.4.1.5923.1.1.1.16
NAME 'eduPersonOrcid'
DESC 'ORCID researcher identifiers belonging to the principal'
EQUALITY caseIgnoreMatch
SYNTAX '1.3.6.1.4.1.1466.115.121.1.15' )
Nota che il formato per questo campo è il ORCID-rappresentazione URI preferita dell'iD, Cioè https://orcid.org/0000-0001-5727-2427.
Ulteriori informazioni sul formato del ORCID iD può essere trovato in Struttura del ORCID identificatore.
ORCID è stata fondata sul principio che i ricercatori dovrebbero avere il controllo sulle loro informazioni. Per onorare questo principio abbiamo un forte politica sulla riservatezza, che è stato progettato per tenere conto delle variazioni locali nelle normative sulla privacy, e ci concentriamo sulla prospettiva del ricercatore nello sviluppo di politiche e funzionalità.
In linea con la nostra principio fondamentale del controllo del ricercatore, ORCID i record possono essere creati solo dai ricercatori stessi, sul ORCID di LPI.
Come parte del flusso di lavoro di integrazione, i tuoi ricercatori potranno registrarsi per un nuovo ORCID iD o accedi al loro record esistente consentendoti di raccogliere i loro documenti autenticati ORCID ID. Si prega di consultare il nostro Tutorial API per maggiori informazioni.
Se ritieni che i dati mostrati sul tuo rapporto non siano accurati, per favore CONTATTACI con il maggior numero di dettagli possibile e il nostro team di coinvolgimento indagherà.
Se la tua organizzazione è un ORCID membro, allora devi contattare il ORCID contattare presso la vostra organizzazione che sarà in grado di fornirvi l'accesso al ORCID Portale membri. Se non sei in grado di identificare le tue organizzazioni ORCID contattare quindi contattare il capofila del consorzio o il rappresentante del team di coinvolgimento.
Adoriamo il feedback della nostra community, quindi per favore fateci sapere se avete feedback sui rapporti dei membri contattandoci all'indirizzo https://support.orcid.org/hc/en-us/requests/new
I dati utilizzati per produrre i rapporti sui membri e sull'integrazione vengono aggiornati quotidianamente.