Phrase TMS API

API Authentication (TMS)

Content is machine translated from English by Phrase Language AI.

Most API calls require an authenticated user. The APIs do not use any special user profiles. Each API can be called on behalf of any existing user using their username and password.


Before calling any API that requires an authenticated user, call the auth/login API to obtain an authentication token. The token is valid for 24 hours and can be used for all subsequent calls, but it will expire if the user logs out via the UI. Do not create a new token for every call.

In subsequent API calls, the obtained token is used in the Authorization header. The header value field is introduced with ApiToken followed by a space and the token itself.

If a user logs out from the UI, the API token will no longer be valid.


ApiToken OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi 

OAuth 2.0

Use OAuth 2.0 in applications instead of sending tokens with each call. Phrase TMS supports a standard OAuth 2.0 authorization code grant type.

To establish the OAuth 2.0 connection, follow these steps:

  1. From the Settings Setup_gear.png page, scroll down to the Integrations section and click on Registered OAuth Apps.

    The Registered OAuth Apps page opens.

  2. Click New.

    The Create OAuth App page opens.

  3. Provide a NameRedirect URI (Callback) and an optional Description.

  4. Click Save.

    The Registered OAuth Apps page opens with the new connection in the list and an associated Client ID.

    The ID is used in the application that connects to Phrase to establish the connection. It is stored in the database and is used to pair requests with the proper requester.

  5. Use these URLs with the generated Client ID for authorization:

    • Auth URL 

    • Token URL 

    If your profile is located in the US DataCenter, add us before, for example

  6. When authorizing, use the Administrator profile to log in and click Allow.

    The application is now linked and the authentication API call will not be required.

Example usage of Bearer token:

Bearer OKTiI2V7QqRDu0HADR2Fk2b9hCteI1pT06bOSk5OD8HSc3oCOHMzIgVtOtLV65hi

Was this article helpful?

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.