Большинство вызовов интерфейс приложений 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 не поддерживается для учетных записей пользователь, которые принадлежат более чем одной организация.
Либо удалить учетную запись пользователь из одной из организация, чтобы она принадлежала только одной организация, либо использовать аутентификация на основе токен.
Чтобы установить соединение 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.cloud.memsource.com/web/oauth/authorize
-
-
При авторизации использовать профиль администратор для входа и нажать Allow.
Приложение теперь связано, и вызов интерфейс приложений API аутентификация не потребуется.
После установления соединения OAuth 2.0 создается токен Bearer для использования в приложении.
Пример использования токена Bearer: