Sign inGet started
Docs
Get started

Aspire API Authentication

How to authenticate Aspire API requests: one Bearer API key plus a connectionId. MindCloud handles Aspire's custom auth scheme for you.

Every Aspire API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Aspire 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 Aspire connection in Connections. Aspire uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
  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 Aspire account that should run the action. MindCloud stores and refreshes the Aspire 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 Get API Version with an Aspire connection looks like this:

curl --request GET \
  --url "https://connect.mindcloud.co/v1/universal/aspire/latest/actions/get-api-version" \
  --header "Authorization: Bearer $MINDCLOUD_API_KEY" \
  --get \
  --data-urlencode "connectionId=$CONNECTION_ID"

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

Set up Aspire credentials

You need an Aspire user account with Admin permissionsThe Aspire access level that lets you manage settings and create credentials..

  1. Create a new Aspire credentialThe connection details Aspire creates so MindCloud can sign in.

    Sign in to Aspire with an account that has Admin permissionsThe Aspire access level that lets you manage settings and create credentials.. Go to Administration > Application > API > New. Add a Description for this integration, choose the access this credentialThe connection details Aspire creates so MindCloud can sign in. should have in ScopeThe access this credential is allowed to use., and select Save.

    Administration → Application → API → New

  2. Copy the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID.

    After Aspire creates the credentialThe connection details Aspire creates so MindCloud can sign in., copy the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID.. Return to the connection form and paste them into the Client IDThe public identifier Aspire gives this connection. and SecretThe private code that pairs with the Client ID. fields.

  3. Choose the correct EnvironmentWhich Aspire system this connection should use.

    In the connection form, choose the EnvironmentWhich Aspire system this connection should use. that matches the Aspire system you want to connect. Select SandboxAspire's test system for trying the integration without using live data. for testing or ProductionYour live Aspire system that uses real data. for your live Aspire system.

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.