A maioria das chamadas de API requer um usuário autenticado. As APIs não usam perfis de usuário especiais. Cada API pode ser chamada em nome de qualquer usuário existente usando seu nome de usuário e senha.
Existem dois métodos para autenticar com a API:
-
Autenticação baseada em token
-
Autenticação OAuth 2.0
Autenticação baseada em token
Antes de chamar qualquer API que requer um usuário autenticado, chame a API auth/login para obter um token de autenticação. O token é válido por 24 horas e pode ser usado para todas as chamadas subsequentes, mas expirará se o usuário sair pela interface do usuário. Não crie um novo token para cada chamada.
Membros de várias organizações TMS têm o mesmo nome de usuário e senha para várias contas. Se várias contas forem usadas, o userUid deve ser adicionado ao corpo da solicitação para especificar em qual organização o usuário quer fazer login. Se não especificado, o usuário fará login na conta padrão associada ao nome de usuário e senha fornecidos.
Em chamadas de API subsequentes, o token obtido é usado no cabeçalho Authorization. O campo de valor do cabeçalho é introduzido com ApiToken seguido de um espaço e o token em si.
Se um usuário sair pela interface do usuário, o token da API não será mais válido.
Se um perfil estiver localizado no DataCenter dos EUA, adicione us. antes de cloud.memsource.com, por exemplo https://us.cloud.memsource.com/web/api2/v3/auth/login.
Exemplo:
Autenticação OAuth 2.0
Use OAuth 2.0 em aplicativos em vez de enviar tokens com cada chamada. O Phrase TMS suporta o tipo de concessão de código de autorização padrão OAuth 2.0 authorization code grant type.
Para estabelecer a conexão OAuth 2.0, siga estas etapas:
-
Na página de Configurações
, role para baixo até a seção e clique em Registered OAuth Apps.
A página é aberta.
-
Clique em New.
A página é aberta.
-
Forneça um , (Callback) e uma opcional.
-
Clique em Save.
A página é aberta com a nova conexão na lista e um associado.
O ID é usado no aplicativo que se conecta ao Phrase para estabelecer a conexão. Ele é armazenado no banco de dados e é usado para emparelhar solicitações com o solicitante apropriado.
-
Use estas URLs com o Client ID gerado para autorização:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Se um perfil estiver localizado no DataCenter dos EUA, adicione us. antes de cloud.memsource.com, por exemplo https://us.cloud.memsource.com/web/oauth/authorize.
-
-
Ao autorizar, use o perfil de administrador para fazer login e clique em Allow.
O aplicativo agora está vinculado e a chamada da API de autenticação não será necessária.
Depois que a conexão OAuth 2.0 é estabelecida, um token Bearer é gerado para usar no aplicativo.
Example usage of Bearer token: