Facciamo del nostro meglio per fornire messaggi di errore descrittivi nel nostro Registro e API. Ecco alcuni suggerimenti per aiutarti a risolvere eventuali errori che potresti riscontrare.
Errori API
I nostri codici di errore API includono messaggi descrittivi che dovrebbero essere facilmente comprensibili.
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.
Errori di formattazione XML/JSON
Se hai problemi con la formattazione dei dati che stai cercando di aggiungere o aggiornare su un ORCID record, si consiglia di consultare esempi di:
- Invio di una chiamata per leggere il record o il singolo elemento per ricevere esempio XML/JSON o, se stai aggiornando un record, l'intero XML/JSON per l'elemento che stai aggiornando e utilizzalo come punto di partenza
- Consultando il nostro file XML e JSON di esempio nel nostro repository GitHub: abbiamo sia XML/JSON puliti per la pubblicazione che XML/JSON completi per esempi di lettura
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.
Errori di ambito
Se ricevi errori relativi agli ambiti, ti consigliamo di:
- Verifica di non utilizzare gli ambiti dei membri con un client API pubblico.
- Se stai aggiungendo, aggiornando o leggendo dati a visibilità limitata, disponi degli ambiti corretti per eseguire l'azione.
- Verificare di non richiedere ambiti a 2 vie utilizzando OAuth a 3 vie e viceversa.
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.
Ambiti a 3 gambe (codice di autorizzazione)
3 gambe si riferisce ai tre attori coinvolti nell'ottenere il permesso da un utente; ORCID, il tuo sistema e l'utente stesso.
/autenticare
Questo ambito viene utilizzato per raccogliere i ORCID iD e leggere le informazioni pubbliche solo sul record. Tutti gli altri ambiti a 3 vie includono l'autorizzazione di autenticazione, quindi questo ambito può essere omesso se si richiede qualsiasi altro accesso. Questo ambito è disponibile nell'API Membro o Pubblica.
/read-limited (solo API membro)
Questo ambito viene utilizzato per ottenere l'accesso alla lettura di elementi pubblici e a visibilità limitata su un ORCID disco. Questo ambito è disponibile solo sull'API membro.
/activities/update (solo API per i membri)
Questo ambito viene utilizzato per scrivere, aggiornare ed eliminare elementi nelle sezioni di affiliazione, finanziamento, lavori, attività professionali, risorse di ricerca e revisione paritaria di un ORCID disco. Questo ambito è disponibile solo sull'API membro.
/person/update (solo API per i membri)
Questo ambito viene utilizzato per scrivere, aggiornare ed eliminare elementi nelle sezioni di altri nomi, parole chiave, paesi, URL dei ricercatori, siti Web e identificatori esterni personali del record. Questo ambito è disponibile solo sull'API membro.
OpenID
Questo ambito viene utilizzato dagli integratori OpenID quando è richiesto un id_token. Quando l'ambito openid è incluso, il registro restituirà un id_token all'interno della risposta del token e concederà al client l'autorizzazione per accedere all'endpoint delle informazioni utente per quell'utente. Questo ambito è disponibile nell'API pubblica e membro.
Si prega di notare che l'ambito 'openid' non inizia con una '/' come l'altro ORCID Ambiti API. Questo perché l'ambito 'openid' non è definito da ORCID, ma invece definito dalla specifica OpenID Connect. Si prega di consultare il nostro Documentazione OpenID per maggiori informazioni.
Scopi multipli Multiple
È possibile richiedere più ambiti in una singola interazione elencando gli ambiti nell'URL di autenticazione con uno spazio codificato tra ciascuno, ad esempio scope=/read-limited%20/activities/update%20/person/update
Accesso completo
Se desideri l'accesso completo per leggere e modificare un record, includi tre ambiti nell'URL di autenticazione: /read-limited, /activities/update e /person/update. Nell'URL apparirebbero come scope=/read-limited%20/activities/update%20/person/update
Ambiti a 2 vie (credenziali client)
Per alcune attività non è necessario chiedere il permesso all'utente. Gli ambiti OAuth a due vie sono richiesti direttamente dal ORCID API e non richiedono al ricercatore di concedere l'autorizzazione. I token con questi ambiti sono validi per 20 anni e possono essere riutilizzati
/leggi-pubblico
Questo ambito viene utilizzato per leggere le informazioni pubbliche su un singolo ORCID ID, cerca ORCID record o per leggere informazioni di riepilogo (solo API membro). Questo ambito è disponibile nell'API membro o pubblica.
/ webhook
Questo ambito consente a un'applicazione client di registrare un webhook su un ORCID record, per ricevere notifiche quando un record viene aggiornato. Questo ambito è disponibile per premium ORCID solo i membri.
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 |
Messaggi di errore del registro
Generalmente i tuoi utenti incontreranno solo alcuni errori relativi alle API quando autorizzano una connessione con la tua applicazione:
URI di reindirizzamento non valido
L'URI di reindirizzamento non corrisponde agli URI di reindirizzamento registrati.
Questo messaggio di errore indica che il tuo link di autorizzazione specifica un URI di reindirizzamento che non hai registrato nelle credenziali del tuo client API. Se stai utilizzando l'API pubblica, puoi risolvere il problema da solo nel tuo Strumenti di sviluppo. Se stai utilizzando l'API per i membri, dovrai richiedere il ORCID Team di coinvolgimento per aggiornare le tue credenziali.
Collegamento errato al modulo di autorizzazione OAuth
Impossibile trovare la pagina richiesta. Se hai questa pagina come segnalibro, eliminala. Se hai seguito un link, segnalacelo.
Questo errore tende a verificarsi quando il collegamento di autorizzazione OAuth è formato in modo errato, ad es https://orcid.org/signin/oauth/authorize?[….] invece di https://orcid.org/oauth/authorize?[…]. Per risolvere, è sufficiente correggere il collegamento.
Messaggio non descrittivo
Si è verificato un problema con il server. Se il problema persiste, contatta l'assistenza.
Questo errore si verifica più spesso quando non viene specificato alcun ambito. È necessario includere un ambito nel collegamento di autorizzazione OAuth; l'ambito minimo è /authenticate.
Controlla se ORCID sta lavorando!
È molto, molto raro, ma se pensi che l'errore sia un problema con il ORCID Server che puoi controllare su http://status.orcid.org/
Notare quello ORCID Sandbox non ha un contratto sul livello di servizio e potrebbe essere inattivo per periodi di 20 minuti quando vengono rilasciati aggiornamenti del codice.
Ottenere aiuto
Siamo sempre felici di aiutarti! ORCID le organizzazioni membri possono ottenere supporto da ORCID direttamente.
Tutti gli integratori sono inoltre incoraggiati ad aderire al ORCID Gruppo utenti API, dove è possibile comunicare con altri integratori e utenti API, nonché con i ORCID squadra.