Docs

Eduzz API Authentication

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

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

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

Connect Eduzz with OAuth2

Use the Eduzz app from GRA-2845. Eduzz requires the MindCloud callback URL to be registered in the app before you start the OAuth flow.

  1. Open the Eduzz Developer Console

    Sign in with the [email protected] Eduzz account and open the app created for MindCloud.

    Eduzz Developer Console
  2. Confirm the callback URL is registered

    In the app settings, make sure the return URL list includes the MindCloud callback URL `https://api.mindcloud.co/v1/oauth/eduzz/callback`.

  3. Start the MindCloud connection

    In MindCloud, choose the Eduzz OAuth2 authentication and start the connect flow.

  4. Approve the Eduzz authorization

    Review the permissions configured on the Eduzz app and approve access for the account you want to connect.

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.