ORCID offre un'API pubblica che consente alle organizzazioni che non lo sono ORCID membri per connettere i loro sistemi e applicazioni al ORCID registro con comunicazioni da macchina a macchina. L'API è un'API riposante e supporta sia XML che JSON.
L'API pubblica può essere utilizzata per le seguenti funzioni:
- Accedi al tuo sistema con ORCID
- Raccogli gli utenti convalidati ORCID iD
- Recupera i dati pubblici da quelli di un utente ORCID record
- Cerca pubblico ORCID dati anagrafici
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 delle API pubbliche
- Fai clic su "Registrati per ORCID Pulsante "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 domanda e genera il mio ID cliente 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.
Sfoglia il nostro Gruppo utenti API argomenti per ulteriori informazioni sulla configurazione di un'integrazione con l'API pubblica. Tuttavia, per massimizzare i benefici di ORCID, ti consigliamo join ORCID come membro dell'organizzazione, che offre accesso a funzionalità aggiuntive, assistenza personale del nostro team di integrazione e, naturalmente, aiuta a supportare il nostro lavoro.