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 chamado em nome de qualquer usuário existente usando seu nome de usuário e senha.
Existem dois métodos de autenticação com a API:
-
Autenticação baseada em token
-
Autenticação OAuth 2.0
Autenticação baseada em token
Antes de ligar para qualquer API que exija um usuário autenticado, ligue para a API de autenticação/login para obter um token de autenticação. O token é válido por 24 horas e pode ser usado em todas as chamadas subsequentes, mas vencerá se o usuário sair pela interface. 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 usuárioUid deve ser adicionado ao corpo de solicitação para especificar qual organização o usuário deseja acessar. Se não especificado, o usuário está conectado à conta padrão associada ao nome de usuário e senha.
Em chamadas de API subsequentes, o token obtido é usado no cabeçalho de autorização. O campo valor do cabeçalho é introduzido com ApiToken seguido de um espaço e o token próprio.
Se um usuário sair da interface, o token da API não será mais válido.
Se um perfil estiver localizado no DataCenter dos EUA, adicione nos. 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 aceita um padrão de tipo de licença de licença de código de autorização OAuth 2.0.
Para estabelecer a conexão OAuth 2.0, siga estes passos:
-
Na página de
de configurações role para baixo até a seção e clique em Aplicativos OAuth registrados.
A página é aberta.
-
Clique em Novo.
A página é aberta.
-
Forneça um , URI de (chamada de retorno) e uma opcional.
-
Clique em Gravar.
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 na base de dados e é usado para emparelhar solicitações com o solicitante apropriado.
-
Usar estes URLs com o ID do cliente gerado para autorização:
-
URL de autorização
https://cloud.memsource.com/web/oauth/authorize
-
URL do token
https://cloud.memsource.com/web/oauth/token
Se um perfil estiver localizado no DataCenter dos EUA, adicione nos. antes de cloud.memsource.com, por exemplo, https://us.cloud.memsource.com/web/oauth/authorize
-
-
Ao autorizar, use o perfil administrador para entrar e clique em Permitir.
O aplicativo está agora vinculado e a chamada da API de autenticação não será necessária.
Assim que a conexão OAuth 2.0 é estabelecida, um token Bearer é gerado para usar no aplicativo.
Exemplo de uso do token Bearer: