Sign inGet started
Docs
Get started

Routee API Authentication

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

Every Routee API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Routee 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 Routee connection in Connections. Routee uses OAuth. When you create the connection, you are redirected to sign in to Routee 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 Routee account that should run the action. MindCloud stores and refreshes the Routee 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 Check Account Balance with an Routee connection looks like this:

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

Connect Routee

You need a Routee account and access to the Applications area in the Routee Platform.

  1. Open the Applications area

    Sign in to the Routee Platform and open the Applications menu.

    Applications
  2. Create or open a Routee application

    Create a new application if you do not already have one. Give it a name and description, then select the Routee services you want this application to access.

    Create a new application
  3. Copy the Application ID and Application Secret

    Open the application settings and copy its Application ID and Application Secret. You will paste those values into the Routee connection in Cirra.

    Settings
  4. Review enabled services and security settings

    Confirm the application includes the Routee services you want to use. If your workspace restricts API access, review the application services and security settings before saving the connection.

    Application services
  5. Save the Routee connection in Cirra

    Paste the Application ID into Client ID and the Application Secret into Client Secret, then save the connection. Routee uses machine-to-machine OAuth2, so there is no browser sign-in step.

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.