What should my integration store?
Cosa dovrebbe memorizzare la mia integrazione?
Integrations need to store more than just ORCID records. Your system will need to be able to:
Accept and store ORCID iDs: Your system will need to know the iD of the ORCID record to update. Store it together with the researcher's information. Our recommendation is to store the full https URI: https://orcid.org/0000-0001-5727-2427.
Accept and store persistent access tokens and refresh tokens: Access tokens can be used to read and update records, as well as indicate that the iD has been authenticated. Persistent tokens are valid for approximately 20 years or until the user revokes them. Refresh tokens can be used to create new access tokens with the same or limited scopes. Store the tokens together with the researcher's information. We also recommend you store the token scope, and the‚token expiry.
Accept and store put codes (if updating ORCID records): Every item that you add to the ORCID Registry will be returned with a put code by the ORCID API. Save this put code along with the item in your system‚ it's how you‚ll identify which item needs to be read or updated.
Log interactions: Your system should record both calls made to the ORCID API and responses received. This is necessary so ORCID can help if a problem develops later.
Provide error messages and a support contact when an interaction does not go as expected.
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 per visualizzare il iD e per aggiornare correttamente. Memorizzalo insieme alle informazioni del ricercatore che vengono restituite nella risposta allo scambio di token. Il nostro consiglio è di archiviare l'URI https completo: https://orcid.org/0000-0001-5727-2427.
Accetta e conserva persistente gettoni di accesso esterni aggiorna i token: i token di accesso possono essere utilizzati per leggere e aggiornare i record, nonché per indicare che il iD è stato autenticato. I token di accesso sono validi per circa 20 anni o finché l'utente non li revoca. Ti consigliamo inoltre di conservare il ambito token, scadenza del token esterni aggiorna i token. I token di aggiornamento possono essere utilizzati per creare nuovi token di accesso con ambiti uguali o limitati, se necessario. Memorizza i dati del token del token di accesso insieme alle informazioni del ricercatore.
Accetta e conserva mettere i codici : ogni elemento aggiunto al file ORCID Il registro verrà restituito con un codice put dal ORCID API. Salva questo codice di inserimento a 6 cifre insieme all'elemento nel tuo sistema, in questo modo identificherai quale elemento deve essere letto, aggiornato o eliminato.
Fornisci messaggi di errore e un contatto di supporto quando un'interazione non va come previsto.