La mayoría de las llamadas a la API requieren un usuario autenticado. Las API no utilizan perfiles de usuario especiales. Puedes llamar a cada API en nombre de cualquier usuario existente con su nombre de usuario y contraseña.
Existen dos métodos para autenticarse con la API:
-
Autenticación basada en tokens
-
Autenticación OAuth 2.0
Autenticación basada en tokens
Antes de llamar a cualquier API que requiera un usuario autenticado, llama a la API auth/login para obtener un token de autenticación. El token es válido durante 24 horas y puede utilizarse para todas las llamadas posteriores, pero caducará si el usuario cierra la sesión a través de la interfaz de usuario. No crees un nuevo token para cada llamada.
Los miembros de varias organizaciones de TMS tienen el mismo nombre de usuario y contraseña para varias cuentas. Si se utilizan varias cuentas, se debe añadir el userUid al cuerpo de la solicitud para especificar en qué organización desea iniciar sesión el usuario. Si no se especifica, el usuario inicia sesión en la cuenta predeterminada asociada al nombre de usuario y la contraseña proporcionados.
En las llamadas posteriores a la API, el token obtenido se utiliza en la cabecera Authorization. El campo de valor de la cabecera se introduce con ApiToken seguido de un espacio y el token en sí.
Si un usuario cierra la sesión desde la interfaz de usuario, el token de API dejará de ser válido.
Si un perfil se encuentra en el centro de datos de EE. UU., añade us. antes de cloud.memsource.com, por ejemplo https://us.cloud.memsource.com/web/api2/v3/auth/login.
Ejemplo:
Autenticación OAuth 2.0
Usa OAuth 2.0 en las aplicaciones en lugar de enviar tokens con cada llamada. Phrase TMS admite un tipo de concesión de código de autorización estándar de OAuth 2.0. Este flujo de OAuth 2.0 es una concesión de código de autorización de cliente público validada solo por URI de redireccionamiento, sin secreto de cliente y sin compatibilidad con PKCE (code_challenge). Antes de continuar, confirma que una herramienta de terceros puede funcionar solo con el Client ID y el URI de redireccionamiento.
Nota
El inicio de sesión OAuth no es compatible con cuentas de usuario que pertenecen a más de una organización.
Elimina la cuenta de usuario de una de las organizaciones para que pertenezca a una sola, o usa la autenticación basada en tokens.
Para establecer la conexión OAuth 2.0, sigue estos pasos:
-
En la página de Configuración
, desplázate hacia abajo hasta la sección y haz clic en Registered OAuth Apps.
Se abre la página .
-
Haz clic en Nuevo.
Se abre la página .
-
Indica un , un (devolución de llamada) y, si quieres, una .
-
Haz clic en Guardar.
Se abre la página con la nueva conexión en la lista y un asociado.
El ID se utiliza en la aplicación que se conecta a Phrase para establecer la conexión. Se almacena en la base de datos y se utiliza para emparejar las solicitudes con el solicitante adecuado.
-
Usa estas URL con el Client ID generado para la autorización:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Si un perfil se encuentra en el centro de datos de EE. UU., añade us. antes de cloud.memsource.com, por ejemplo https://us.cloud.memsource.com/web/oauth/authorize.
-
-
Al autorizar, usa el perfil de Administrador para iniciar sesión y haz clic en Allow.
La aplicación ya está vinculada y no se requerirá la llamada a la API de autenticación.
Una vez establecida la conexión OAuth 2.0, se genera un token de portador para su uso en la aplicación.
Ejemplo de uso del token de portador:
Validez del token de portador
Un token de portador OAuth 2.0 sigue siendo válido cuando el usuario que autorizó la aplicación cierra la sesión de Phrase. Esto difiere de un token de API obtenido a través de auth/login, el cual caduca cuando el usuario cierra la sesión.
Un token de portador deja de funcionar cuando:
-
Se cambia la contraseña del usuario que autorizó la aplicación.
-
La aplicación OAuth se elimina en la página .