La maggior parte delle chiamate API richiede un utente autenticato. Le API non usano profili utente speciali. Ogni API può essere chiamata per conto di qualsiasi utente esistente utilizzando il suo nome utente e password.
Esistono due metodi per autenticarsi con l’API:
-
Autenticazione basata su token
-
Autenticazione OAuth 2.0
Autenticazione basata su token
Prima di chiamare qualsiasi API che richieda un utente autenticato, chiamare l’API auth/login per ottenere un token di autenticazione. Il token è valido per 24 ore e può essere utilizzato per tutte le chiamate successive, ma scadrà se l'utente si disconnette tramite l'interfaccia utente. Non creare un nuovo token per ogni chiamata.
I membri di più organizzazioni TMS hanno lo stesso nome utente e password per più account. Se si utilizzano più account, lo userUid deve essere aggiunto al corpo della richiesta per specificare a quale organizzazione l'utente vuole accedere. Se non specificato, l'utente ha effettuato l’accesso all’account predefinito associato al nome utente e alla password specificati.
Nelle chiamate API successive, il token ottenuto viene utilizzato nell'intestazione dell'autorizzazione. Il campo del valore di intestazione viene introdotto con ApiToken seguito da uno spazio e dal token stesso.
Se un utente esce dall’interfaccia utente, il token API non sarà più valido.
Se un profilo si trova nel centro dati statunitense, aggiungici . prima di cloud.memsource.com, ad esempio https://us.cloud.memsource.com/web/api2/v3/auth/login.
Esempio:
Autenticazione OAuth 2.0
Usa OAuth 2.0 nelle applicazioni invece di inviare token a ogni chiamata. Phrase TMS supporta un tipo di codice standard di autorizzazione OAuth 2.0.
Per stabilire la connessione con OAuth 2.0, segui i passaggi riportati di seguito:
-
Dalla pagina di
Impostazioni, scorri verso il basso fino alla sezione e fai clic su App OAuth registrate.
Si aprirà la pagina .
-
Fai clic su Nuovo.
Si aprirà la pagina .
-
Fornire un , un (Callback) e una facoltativa.
-
Fai clic su Salva.
Si apre la pagina con la nuova connessione nell'elenco e un associato.
L'ID viene utilizzato nell'applicazione che si connette a phrase per stabilire la connessione. Viene archiviato nel database e viene utilizzato per abbinare le richieste al richiedente corretto.
-
Usa questi URL con l'ID cliente generato per l'autorizzazione:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Se un profilo si trova nel centro dati statunitense, aggiungici . prima di cloud.memsource.com, ad esempio https://us.cloud.memsource.com/web/oauth/authorize
-
-
Quando si autorizza, usare il profilo amministratore per accedere e fare clic su Consenti.
L’applicazione è ora collegata e non sarà necessaria la chiamata API di autenticazione.
Una volta stabilita la connessione con OAuth 2.0, viene generato un token Bearer da usare nell’applicazione.
Esempio di utilizzo del token Bearer: