La maggior parte delle chiamate API richiede un utente autenticato. Le API non utilizzano profili utente speciali. Ogni API può essere chiamata per conto di qualsiasi utente esistente utilizzando il proprio nome utente e password.
Ci sono 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 richiede un utente autenticato, chiama 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 esce 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 vengono utilizzati 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 accede all'account predefinito associato al nome utente e alla password forniti.
Nelle chiamate API successive, il token ottenuto viene utilizzato nell'intestazione Authorization. Il campo valore dell'intestazione è 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 DataCenter degli Stati Uniti, aggiungi us. 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 con ogni chiamata. Phrase TMS supporta un tipo di concessione di codice di autorizzazione standard OAuth 2.0 authorization code grant type.
Per stabilire la connessione OAuth 2.0, segui questi passaggi:
-
Dalla pagina delle Impostazioni
, scorri verso il basso fino alla sezione e fai clic su Registered OAuth Apps.
Si apre la pagina .
-
Fai clic su Nuovo.
Si apre la pagina .
-
Fornisci un , (Callback) e una facoltativa.
-
Fai clic su Salva.
Si apre la pagina con la nuova connessione nell'elenco e un associato.
L'ID è utilizzato nell'applicazione che si connette a Phrase per stabilire la connessione. È memorizzato nel database e viene utilizzato per abbinare le richieste con il richiedente corretto.
-
Usa 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 degli Stati Uniti, aggiungi us. prima di cloud.memsource.com, ad esempio https://us.cloud.memsource.com/web/oauth/authorize
-
-
Quando autorizzi, usa il profilo dell'Amministratore per accedere e fai clic su Allow.
L'applicazione è ora collegata e la chiamata API di autenticazione non sarà necessaria.
Una volta stabilita la connessione OAuth 2.0, viene generato un token Bearer da utilizzare nell'applicazione.
Esempio di utilizzo del token Bearer: