Order Sender API Authentication

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

Every Order Sender API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Order Sender 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

Create a MindCloud account at app.mindcloud.co if you do not already have one.
Generate a MindCloud API Key in API Keys. This is the Bearer token you send on every request. Keep it on your server.
Create a Order Sender connection in Connections. Order Sender uses its own authentication scheme. You provide whatever it requires when you create the connection — MindCloud handles the provider-specific details for you.
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 Order Sender account that should run the action. MindCloud stores and refreshes the Order Sender 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 Verify Connection with an Order Sender connection looks like this:

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

Connect Order Sender

You need an active Order Sender Business tenant with API access enabled.

Open API Management
Sign in to Order Sender Business and open the API Management page.
Copy the company code
Find the tenant company code used as the cod query parameter on every API request.
Generate or copy the API token
Generate a new API token if needed and copy the OSBusiness token value.
Paste both values into MindCloud
Enter the Company Code and API Token exactly as shown. MindCloud sends them as the cod and token query parameters on every request.

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.