Sign inGet started
Docs
Get started

Phrase API Authentication

How to authenticate Phrase API requests: one Bearer API key plus a connectionId. MindCloud runs the OAuth flow and refreshes Phrase tokens for you.

Every Phrase API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Phrase account. This page covers both, plus exactly how to send them, so you do not need to visit any other page to get authenticated.

Steps to authenticate

  1. Create a MindCloud account at app.mindcloud.co if you do not already have one.
  2. Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
  3. Create a Phrase connection in Connections. Phrase uses OAuth. When you create the connection, you are redirected to sign in to Phrase and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
  4. Copy the connection’s connectionId — you will send it on every request alongside your MindCloud API Key.

How requests are authenticated

Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Phrase account that should run the action. MindCloud stores and refreshes the Phrase credentials behind that connection, so you never send provider tokens with your requests.

Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions.

For example, calling List Accounts with an Phrase connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/phrase/actions/list-accounts/run" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --header "Content-Type: application/json" \
  --data '{
  "connectionId": "$CONNECTION_ID",
  "arguments": {}
}'

The Authorization: Bearer <your MindCloud API Key> header authenticates you to MindCloud; the connectionId tells MindCloud which Phrase account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Create a Phrase Platform access token

You need access to the Phrase Platform organization that owns the Phrase Strings workspace you want to connect.

  1. Open your Phrase profile settings

    In the Phrase Platform dashboard, open the user menu in the top-right corner, select Settings, then open Profile.

    Settings → Profile
  2. Open the Access tokens tab

    Select the Access tokens tab on the Profile page.

    Settings → Profile → Access tokens

  3. Generate a token for Phrase Strings

    Click Generate token, enter a token name, and choose Phrase Strings from the Service dropdown.

  4. Copy the token into MindCloud

    Copy the one-time token value immediately, then paste it into the Platform Access Token field when creating the MindCloud connection.

Keep your key safe

Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs. Anyone with the key can call the Universal API as your MindCloud account, across every connection you have created.