A maioria das chamadas de API requer um usuário autenticado. As APIs não usar nenhum perfil de usuário especial. 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 exija 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 via interface do usuário. Não Criar um novo token para cada chamada.
Membros de múltiplas organizações TMS têm o mesmo nome de usuário e senha para múltiplas contas. Se múltiplas contas forem usadas, o userUid deve ser adicionado ao corpo da solicitação para especificar em qual organização o usuário deseja fazer login. Se não especificado, o usuário é conectado à 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 por um espaço e o token em si.
Se um usuário sair da interface do usuário, o token de API não será mais válido.
Se um perfil estiver localizado no DataCenter dos EUA, adicionar us. antes de cloud.memsource.com, por exemplo https://us.cloud.memsource.com/web/api2/v3/auth/login.
Exemplo:
Autenticação OAuth 2.0
Usar OAuth 2.0 em aplicativos em vez de enviar tokens a cada chamada. O Phrase TMS suporta um authorization code grant type OAuth 2.0 padrão.
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 abre.
-
Clique em Novo.
A página abre.
-
Forneça um , (Callback) e uma opcional.
-
Clique em Gravar.
A página abre 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 parear solicitações com o solicitante adequado.
-
Usar 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, adicionar us. antes de cloud.memsource.com, por exemplo https://us.cloud.memsource.com/web/oauth/authorize
-
-
Ao autorizar, usar o perfil de administrador para fazer login e clicar em Allow.
O aplicativo agora está vinculado e a chamada de API de autenticação não será necessária.
Uma vez que a conexão OAuth 2.0 é estabelecida, um token Bearer é gerado para usar no aplicativo.
Exemplo de uso de token Bearer: