La maggior parte delle chiamate API richiede un utente autenticato. Le API non usano alcun profilo utente speciale. Ogni API può essere chiamata per conto di qualsiasi utente esistente usando il proprio nome utente e password.
Esistono due metodi per l'autenticazione 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 usato per tutte le chiamate successive, ma scadrà se l'utente effettua il logout tramite l'interfaccia utente. Non Crea un nuovo token per ogni chiamata.
I membri di più organizzazioni TMS hanno lo stesso nome utente e password per più account. Se vengono usati più account, il userUid deve essere aggiunto al corpo della richiesta per specificare a quale organizzazione l'utente desidera accedere. Se non specificato, l'utente viene connesso all'account predefinito associato al nome utente e alla password forniti.
Nelle chiamate API successive, il token ottenuto viene usato nell'intestazione Authorization. Il campo del valore dell'intestazione viene introdotto con ApiToken seguito da uno spazio e dal token stesso.
Se un utente effettua il logout dall'interfaccia utente, il token API non sarà più valido.
Se un profilo si trova nel DataCenter statunitense, aggiungere us. prima di cloud.memsource.com, ad esempio https://us.cloud.memsource.com/web/api2/v3/auth/login.
Esempio:
Autenticazione OAuth 2.0
Usare OAuth 2.0 nelle applicazioni invece di inviare token con ogni chiamata. Phrase TMS supporta un authorization code grant type OAuth 2.0 standard.
Per stabilire la connessione OAuth 2.0, seguire questi passaggi:
-
Dalla pagina impostazioni
, scorrere verso il basso fino alla sezione e fare clic su Registered OAuth Apps.
Si apre la pagina .
-
Fai clic su Nuovo.
Si apre la pagina .
-
Fornire un , un (Callback) e una opzionale.
-
Clicca su Salva.
Si apre la pagina con la nuova connessione nell'elenco e un associato.
L'ID viene usato nell'applicazione che si connette a Phrase per stabilire la connessione. Viene memorizzato nel database e usato per associare le richieste al richiedente corretto.
-
Usare questi URL con il Client ID 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 DataCenter statunitense, aggiungere us. prima di cloud.memsource.com, ad esempio https://us.cloud.memsource.com/web/oauth/authorize
-
-
Durante l'autorizzazione, usare il profilo amministratore per accedere e fare clic su Allow.
L'applicazione è ora collegata e la chiamata API di autenticazione non sarà richiesta.
Una volta stabilita la connessione OAuth 2.0, viene generato un token Bearer da usare nell'applicazione.
Esempio di uso del token Bearer: