Sign inGet started
Docs
Get started

Craftboxx API Authentication

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

Every Craftboxx API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your Craftboxx 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 Craftboxx connection in Connections. Craftboxx 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 Craftboxx account that should run the action. MindCloud stores and refreshes the Craftboxx 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 Employees with an Craftboxx connection looks like this:

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

Connect Craftboxx

You need a Craftboxx employee account with Planner access and an email address plus password.

  1. Open employee management in Craftboxx

    In Craftboxx Planner, open the admin area and go to employee management so you can create or edit the employee account you want to use for the API connection.

    Adminbereich → Mitarbeiter verwalten
  2. Create or update an employee with Planner access

    Make sure the employee has access to the Planner, because the API uses the same permissions as the employee account.

  3. Assign an email address and password

    Set an email address and password for that employee so the account can create an API bearer token.

    Personal → Planer & Appzugang verwalten
  4. Enter the credentials in MindCloud

    Back in MindCloud, open the Craftboxx connection and enter the employee email address and password.

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.