La mayoría de las llamadas a la API requieren un usuario autenticado. Las API no utilizan perfiles de usuario especiales. Cada API puede ser llamada en nombre de cualquier usuario existente utilizando su nombre de usuario y contraseña.
Hay dos métodos para autenticarse con la API:
-
Autenticación basada en identificador único (token)
-
Autenticación OAuth 2.0
Autenticación basada en identificador único (token)
Antes de llamar a cualquier API que requiera un usuario autenticado, llama a la API auth/login para obtener un identificador único (token) de autenticación. El identificador único (token) es válido por 24 horas y puede usarse para todas las llamadas subsiguientes, pero expirará si el usuario cierra sesión desde la interfaz de usuario. No crees un nuevo identificador único (token) para cada llamada.
Los miembros de varias organizaciones TMS tienen el mismo nombre de usuario y contraseña para varias cuentas. Si usas varias cuentas, el userUid debe agregarse al cuerpo de la solicitud para especificar a qué organización el usuario quiere iniciar sesión. Si no se especifica, el usuario inicia sesión en la cuenta predeterminada asociada con el nombre de usuario y la contraseña dados.
En llamadas a la API posteriores, el identificador único (token) obtenido se usa en el encabezado Authorization. El campo de valor del encabezado comienza con ApiToken, seguido de un espacio y el identificador único (token) en sí.
Si un usuario cierra sesión desde la interfaz de usuario, el identificador único (token) de la API ya no será válido.
Si un perfil se encuentra en el Centro de Datos de EE. UU., agrega 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 aplicaciones en vez de enviar identificadores únicos (token) con cada llamada. Phrase TMS admite el tipo de concesión de código de autorización estándar OAuth 2.0 authorization code grant type.
Para establecer la conexión OAuth 2.0, sigue estos pasos:
-
Desde 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 New.
Se abre la página .
-
Proporciona un , (Callback) y una opcional.
-
Haz clic en Save.
La página se abre 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 solicitudes con el solicitante adecuado.
-
Usa estas URL con el ID de cliente 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., agrega 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 ahora está vinculada y no se requerirá la llamada a la API de autenticación.
Una vez que se establece la conexión OAuth 2.0, se genera un identificador único (token) Bearer para usar en la aplicación.
Example usage of Bearer token: