Skip to main content

Crayon Cloud-iQ

About​

Crayon Cloud-iQ is Crayon's cloud services management platform for CSP (Cloud Solution Provider) operations. The ZaveIT integration connects to your Cloud-iQ account, letting you manage customers, subscriptions, Microsoft NCE products, and orders directly from the ZaveIT Platform.

Capabilities​

The Crayon Cloud-iQ integration provides the following capabilities:

  • Sync Customers - Bi-directional synchronization keeps customer tenant accounts consistent between ZaveIT and Crayon. Import existing tenants or export new ones from ZaveIT.
  • Import Products - Pull Crayon's agreement product catalog into ZaveIT, including Microsoft CSP products with pricing, billing cycles, and term durations.
  • Create Orders - Submit New Commerce Experience (NCE) orders to Crayon directly from ZaveIT. Orders are placed through Crayon's NCE ordering API.
  • Credential Validation - Test your API credentials during setup to verify the connection before saving.

Getting Started​

Step 1: Create an API Client​

  1. Log in to Crayon Cloud-iQ.
  2. Navigate to Manage → API Management.
  3. Create a new API client or view an existing one.
  4. Copy the Client ID and Client Secret.
warning

The Client Secret is only shown when the API client is created. Copy and store it in a safe place. If you lose it, you need to generate a new secret.

Step 2: Create a Dedicated API User​

  1. In Cloud-iQ, create a new user account specifically for API access.
  2. Use a non-personal email address (for example, api@yourcompany.com).
  3. Assign the user the appropriate permissions for managing customers, products, and orders.
  4. Note the email address and password for this user.
tip

Use a dedicated API user rather than a personal account. This ensures the integration continues working if an employee leaves the organization or changes their password.

Step 3: Configure in ZaveIT​

  1. In the ZaveIT Platform, navigate to Settings → Integrations.
  2. Find Crayon Cloud-iQ and click Configure.
  3. Enter your Client ID, Client Secret, API Username, and API Password.
  4. Click Save.

The integration validates your credentials by requesting an OAuth token and verifying it against the Crayon API. If the connection is successful, the integration status changes to active.

Configuration Reference​

FieldDescriptionWhere to find it
Client IDYour Crayon API client identifierCloud-iQ → Manage → API Management
Client SecretYour Crayon API client secretCloud-iQ → Manage → API Management (shown at creation)
API UsernameDedicated API user email addressThe email of the API user you created
API PasswordPassword for the dedicated API userThe password of the API user you created

Considerations​

  • Token management - The integration authenticates using OAuth 2.0 with Resource Owner Password Credentials (ROPC). Tokens are cached automatically and refreshed before they expire. No manual token management is needed.
  • Organization context - Crayon requires an Organization ID for most API calls. The integration discovers this automatically from your account on the first request.
  • Microsoft NCE orders - The integration uses Crayon's New Commerce Experience (NCE) ordering flow for Microsoft CSP products. Each order item is submitted individually with a part number, billing cycle, and term duration.
  • Customer model - Crayon uses a composite customer model (CustomerTenantDetailed) with four sub-objects: Tenant, User, Profile, and Company. The integration handles this mapping automatically when syncing customers.
  • Product catalog size - Crayon agreement product catalogs can be large (thousands of products). The initial import may take some time. The integration paginates automatically.