Интерфейс приложений API Phrase TMS

Аутентификация API (TMS)

Контент автоматически переведен с английского языка с помощью Phrase Language AI.

Большинство вызовов 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.

Пример: 

ApiToken OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi 

Аутентификация OAuth 2.0

Используйте OAuth 2.0 в приложениях вместо отправки токенов с каждым вызовом. Phrase TMS поддерживает стандартный тип авторизации OAuth 2.0 с помощью кода авторизации. В этом потоке OAuth 2.0 для общедоступного клиента используется авторизация с помощью кода авторизации: проверяется только URI перенаправления, а секрет клиента и PKCE (code_challenge) не поддерживаются. Перед продолжением убедитесь, что сторонний инструмент может работать только с идентификатором клиента и URI перенаправления.

Примечание

Вход через OAuth не поддерживается для учетных записей пользователей, которые принадлежат более чем одной организации.

Либо удалите учетную запись пользователя из одной из организаций, чтобы она осталась только в одной организации, либо используйте вместо этого аутентификацию на основе токенов.

Чтобы установить соединение OAuth 2.0, выполните следующие действия:

  1. На странице «Настройки» Setup_gear.png прокрутите вниз до раздела «Интеграции» и нажмите «Зарегистрированные приложения OAuth».

    Откроется страница «Зарегистрированные приложения OAuth».

  2. Нажмите «Создать».

    Откроется страница «Создать приложение OAuth».

  3. Укажите «Имя», «URI перенаправления» (адрес обратного вызова) и, при необходимости, «Описание».

  4. Нажмите Сохранить.

    Откроется страница «Зарегистрированные приложения OAuth»: в списке появится новое подключение и связанный с ним «Идентификатор клиента».

    Этот идентификатор используется для установления соединения в приложении, которое подключается к Phrase. Он хранится в базе данных и используется для сопоставления запросов с соответствующим отправителем.

  5. Используйте эти 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.

  6. При авторизации войдите в систему с профилем администратора и нажмите «Разрешить».

    Приложение теперь подключено, и вызов API для аутентификации не потребуется.

После установления соединения OAuth 2.0 для использования в приложении создается токен Bearer.

Пример использования токена Bearer:

Bearer OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi 

Срок действия токена Bearer

Токен Bearer OAuth 2.0 остается действительным даже после выхода из Phrase пользователя, авторизовавшего приложение. В отличие от токена Bearer, токен API, полученный через auth/login, перестает действовать при выходе пользователя из системы.

Токен Bearer перестает работать, если:

  • Пароль пользователя, авторизовавшего приложение, изменен.

  • Приложение OAuth удалено на странице «Зарегистрированные приложения OAuth».

Была ли эта статья полезной?
★ ★ ★ ★ ★

Sorry about that! In what way was it not helpful?

The article didn’t address my problem.
I couldn’t understand the article.
The feature doesn’t do what I need.
Other reason.

Note that feedback is provided anonymously so we aren't able to reply to questions.
If you'd like to ask a question, submit a request to our Support team.
Thank you for your feedback.