Большинство вызовов интерфейса приложений 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: