Большинство вызовов API требуют аутентифицированного пользователя. Интерфейсы API не используют никаких специальных профилей пользователей. Каждый API можно вызвать от имени любого существующего пользователя, используя его имя пользователя и пароль.
Существует два метода аутентификации для работы с API:
-
Аутентификация на основе токена
-
Аутентификация OAuth 2.0
Аутентификация на основе токена
Перед вызовом любого API, который требует аутентифицированного пользователя, вызовите API auth/login для получения токена аутентификации. Токен действителен в течение 24 часов и может использоваться для всех последующих вызовов, но он истечет, если пользователь выйдет из системы через интерфейс. Не нужно создавать новый токен для каждого вызова.
Члены нескольких организаций TMS имеют одно и то же имя пользователя и пароль для нескольких учетных записей. Если используются несколько учетных записей, userUid должен быть добавлен в тело запроса, чтобы указать, в какую организацию пользователь хочет войти. Если не указано, пользователь входит в учетную запись по умолчанию, связанную с данным именем пользователя и паролем.
В последующих вызовах API полученный токен используется в заголовке Authorization. Поле значения заголовка начинается с ApiToken, за которым следует пробел и сам токен.
Если пользователь выходит из интерфейса, токен API больше не будет действительным.
Если профиль находится в центре обработки данных США, добавьте us. перед cloud.memsource.com, например https://us.cloud.memsource.com/web/api2/v3/auth/login.
Пример:
Аутентификация OAuth 2.0
Следует использовать OAuth 2.0 в приложениях вместо передачи токенов с каждым вызовом. Phrase TMS поддерживает стандартный тип предоставления кода авторизации OAuth 2.0 authorization code grant type.
Чтобы установить соединение OAuth 2.0, выполните следующие шаги:
-
На странице «настройки»
прокрутите вниз до раздела «интеграция» и нажмите на Registered OAuth Apps.
Открывается страница .
-
Нажмите Новый.
Открывается страница .
-
Укажите , (Callback) и, при необходимости, .
-
Нажмите «Сохранить».
Страница открывается с новым соединением в списке и связанным
Идентификатор используется в приложении, которое подключается к Phrase для установления соединения. Он хранится в базе данных и используется для сопоставления запросов с правильным запрашивающим лицом.
-
Используйте эти URL-адреса с сгенерированным Идентификатором клиента для авторизации:
-
Auth URL
https://cloud.memsource.com/web/oauth/authorize
-
Token URL
https://cloud.memsource.com/web/oauth/token
Если профиль находится в центре обработки данных США, добавьте us. перед cloud.memsource.com, например: https://us.<7>cloud.memsource.com/web/oauth/authorize
-
-
При авторизации используйте профиль администратора для входа и нажмите «Разрешить».
Приложение теперь связано, и вызов API аутентификации не потребуется.
После установления соединения OAuth 2.0 генерируется токен Bearer для использования в приложении.
Пример использования токена Bearer: