Starshipit API Authentication

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

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

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

Get your Starshipit API credentials

You need a Starshipit account. For rates-related calls, Starshipit also requires at least one enabled courier on the account.

Sign in to Starshipit
Log in to your Starshipit account so you can access the API settings area.
Open Settings > API
In Starshipit, go to Settings and then open the API page.
Copy or generate your API Key
Create or copy the API key shown on the API page. Use this value in the MindCloud API Key field.
Copy or generate your Subscription Key
Create or copy the subscription key shown on the same API page. Use this value in the MindCloud Subscription Key field.

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.