Для большинства обращений по интерфейсу приложений API требуется аутентифицированный пользователь. API не используют никаких специальных профилей пользователей. Каждый интерфейс приложений API можно вызвать от имени любого существующего пользователя, используя его имя пользователя и пароль.
Существует два метода аутентификации с помощью интерфейса приложений API:
-
аутентификация на основе токен
-
Аутентификация OAuth 2.0
Аутентификация на основе токенов
Прежде чем вызвать интерфейс приложений API, требующий аутентификации пользователя, позвоните в интерфейс приложений API аутентификации/логина, чтобы получить токен аутентификации. Токен действителен в течение 24 часов и может быть использован для всех последующих обращений, но срок его действия истечет, если пользователь выйдет из системы через пользовательский интерфейс. Не создайте новый токен для каждого обращения.
Члены нескольких организаций TMS имеют одинаковые логин и пароль для нескольких учетных записей. Если используется несколько учетных записей, необходимо добавить userUid
в тело запроса, чтобы указать, в какую организацию пользователь хочет войти. Если не указано, пользователь входит в учетную запись по умолчанию, связанную с данным именем пользователя и паролем.
При последующих обращениях к интерфейсу приложений API полученный токен используется в заголовке «Авторизация
». Поле значения заголовка вводится с помощью ApiToken
, за которым следует каталог и сам токен.
Если пользователь выйдет из пользовательского интерфейса приложений API, токен больше не будет действителен.
Если профиль находится в Центре обработки данных США, добавьте нас. перед cloud.memsource.com, например https://us.cloud.memsource.com/web/api2/v3/auth/login.us.cloud.memsource.com/web/api2/v3/auth/login.
Пример:
Аутентификация OAuth 2.0
Используйте OAuth 2.0 в приложениях вместо отправки токенов с каждым обращением. Phrase TMS поддерживает стандартный тип гранта кода авторизации OAuth 2.0.
Чтобы установить соединение OAuth 2.0, выполните следующие действия:
-
На странице
настроек прокрутите вниз раздел « и нажмите «Зарегистрированные OAuth Apps».
Открывается страница
. -
Нажмите «Создать».
Открывается страница
. -
Укажите
, (обратный вызов) и дополнительное . -
Нажмите «Сохранить».
Открывается страница
с новым подключением в списке и связанным с ним .Идентификатор используется в приложении, которое подключается к Phrase для установления соединения. Он хранится в базе данных и используется для сочетания запросов с соответствующим запросчиком.
-
Используйте для авторизации следующие URL-адреса со сгенерированным Идентификатором клиента:
-
Авторский URL-адрес
https://cloud.memsource.com/web/oauth/authorize
-
URL токена
https://cloud.memsource.com/web/oauth/token
Если профиль находится в центре обработки данных США, добавьте нас. перед cloud.memsource.com, например: https://us.cloud.memsource.com/web/oauth/authorize
-
-
Используйте профиль администратора для входа в систему и нажмите «Разрешить».
Теперь приложение привязано, и вызов интерфейса приложений API для аутентификации не потребуется.
После установления соединения OAuth 2.0 генерируется токен на предъявителя, который будет использован в приложении.
Пример использования токена на предъявителя: