EZICHEQ API Authentication

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

Every EZICHEQ API request through MindCloud needs two things: a MindCloud API Key and a connectionId for your EZICHEQ 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 EZICHEQ connection in Connections. EZICHEQ uses OAuth. When you create the connection, you are redirected to sign in to EZICHEQ and approve access — MindCloud stores the resulting tokens and refreshes them automatically, so your integration never has to.
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 EZICHEQ account that should run the action. MindCloud stores and refreshes the EZICHEQ 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 Test Connection with an EZICHEQ connection looks like this:

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

Set up EZICHEQ OAuth2

Use an EZICHEQ user account that can register apps. Keep the app registration client ID and client secret ready. The redirect URI must match exactly: https://api.mindcloud.co/v1/oauth/ezicheq/callback.

Register the app in EZICHEQ
Open EZICHEQ registration and create the app using the MindCloud redirect URI. Copy the client ID and client secret that EZICHEQ gives you.
Registration
Let the user approve the connection
Send the user through EZICHEQ authorization with response_type=code, the app client ID, a random state value, and the MindCloud redirect URI.
Authorisation (connecting)
Exchange the code for tokens
POST the code to the token endpoint using the same redirect URI and the registered client credentials.
Authorisation (connecting)

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.