Большинство вызовов интерфейса приложений 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. Этот поток OAuth 2.0 представляет собой предоставление кода авторизации для публичного клиента, подтверждаемое только URI перенаправления, без секрета клиента и без поддержки PKCE (code_challenge). Подтвердить, что сторонний инструмент может работать только с Идентификатором клиента и URI перенаправления, прежде чем продолжить.
Примечание
Вход через OAuth не поддерживается для учетных записей пользователей, которые принадлежат более чем одной организации.
Либо удалить учетную запись пользователя из одной из организаций, чтобы она принадлежала только одной организации, либо использовать аутентификацию на основе токена.
Чтобы установить соединение OAuth 2.0, выполните следующие действия:
-
На странице настройки
прокрутите вниз до раздела и нажмите Зарегистрированные OAuth-приложения.
Откроется страница .
-
Нажмите «Создать».
Откроется страница .
-
Укажите , (Callback) и необязательное .
-
Нажмите Сохранить.
Откроется страница со списком, содержащим новое подключение и связанный с ним .
Идентификатор используется в приложении, которое подключается к Phrase для установления соединения. Он хранится в базе данных и используется для сопоставления запросов с соответствующим запрашивающим лицом.
-
Использовать эти URL-адреса с созданным Идентификатором клиента для авторизации:
-
URL-адрес аутентификации
https://cloud.memsource.com/web/oauth/authorize
-
URL-адрес токена
https://cloud.memsource.com/web/oauth/token
Если профиль находится в центре обработки данных США, добавьте us. перед cloud.memsource.com, например https://us.cloud.memsource.com/web/oauth/authorize.
-
-
При авторизации используйте профиль администратора для входа в систему и нажмите Разрешить.
Приложение теперь связано, и вызов интерфейс приложений API аутентификации не потребуется.
Как только соединение OAuth 2.0 установлено, генерируется токен Bearer для использования в приложении.
Пример использования токена Bearer: