Docs

Stax API Authentication

How to authenticate Stax API requests: one Bearer API key plus a connectionId. MindCloud stores your Stax API key securely — set it once, never resend it.

Every Stax API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Stax 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 Stax connection in Connections. Stax uses an API key. You generate the key in your Stax account, then paste it in when you create the connection — MindCloud stores it securely and never returns it in a response.
  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 Stax account that should run the action. MindCloud stores and refreshes the Stax 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 Customers with an Stax connection looks like this:

curl --request POST \
  --url "https://connect.mindcloud.co/v2/universal/apps/stax/actions/list-customers/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 Stax account to run the action against. Missing or invalid Authorization returns 401, and a missing or mismatched connectionId returns 400.

Set up your Stax merchant API key

Sign in to the Stax merchant account that MindCloud should access. Use a merchant API key for server-side API requests; the hosted payments token is a separate credential used for web payment flows.

  1. Locate or create a Stax merchant API key

    Open your Stax merchant account and use the merchant API key flow described in the Stax developer documentation to work with your API credentials.

  2. Copy the API key value

    Copy the full merchant API key value and keep it private. Treat it like a server-side secret.

  3. Paste the key into MindCloud

    Enter the Stax key into the MindCloud Stax connection as the API Key credential.

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.