Accesso al ORCID L'API pubblica richiede un set di credenziali composto da un ID client e un segreto client. Questa guida descrive i passaggi necessari per ottenere ORCID Credenziali API pubbliche. ORCID i membri non devono registrarsi per l'API pubblica poiché è possibile utilizzare le loro credenziali di membro. Per registrarsi per le credenziali dei membri vedere Registra un'applicazione client.
Le credenziali dell'API pubblica sono legate a quelle di un individuo ORCID record e non può essere trasferito a un'altra persona. Dovrai accettare il Termini di servizio del cliente pubblico prima del rilascio delle credenziali.
Le credenziali dell'API organizzativa sono disponibili per le organizzazioni che supportano ORCID attraverso un abbonamento a pagamento. Scopri ORCID iscrizione.
Consigliamo agli sviluppatori di testare l'API pubblica nel server di test sandbox prima di utilizzare la versione di produzione.
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.
ORCID supporta diverse quote di utilizzo API e limiti di velocità a seconda dell'API utilizzata.
| API | API anonima | API pubblica (registrata) | API membro |
| Limite di tariffa | 12 richieste/sec40 raffiche/sec | 12 richieste/sec40 raffiche/sec | 24 richieste/sec40 raffiche/sec |
| Quota di utilizzo | 50k letture/giorno (Per indirizzo IP) | 100k letture/giorno (per ID cliente) | Nessuna quota di utilizzo |
Richiede un secondo è il numero di richieste che possono essere effettuate al secondo.
Bursts sono il numero di richieste che consentiremo di mettere in coda prima di rifiutarle. Le richieste in coda vengono rallentate alla velocità di richieste al secondo. Se superi il burst, otterrai una risposta 503.
Se superi la quota di utilizzo, non potrai più effettuare ulteriori richieste entro il lasso di tempo stabilito.
Si prega di ricordare che il ORCID L'API pubblica è gratuita per uso non commerciale da parte di individui come indicato nel Termini di servizio delle API pubblicheCon "non commerciale" intendiamo che non puoi addebitare alcuna tariffa di riutilizzo per l'API pubblica e non puoi utilizzare l'API pubblica in relazione a nessun prodotto o servizio che generi entrate.
Utilizzando l'API pubblica con credenziali client, la tua integrazione avrà una quota di utilizzo maggiore rispetto all'API anonima. Consulta il nostro guida all'integrazione su come registrare un client API pubblico.
Se superi regolarmente la quota di utilizzo dell'API per l'API pubblica, ti consigliamo di prendere in considerazione l'idea di diventare un ORCID membro per l'accesso al nostro API membro. Non solo ti consentirà di accedere a un limite di velocità più elevato e a una quota di utilizzo illimitata, ma sarai in grado di accedere ai dati di Trusted Party in ORCID registra e contribuisce con i dati a ORCID registrazioni dai sistemi istituzionali con l'autorizzazione degli utenti.