DIVE Online API - Integrations

The Integrations endpoints allows the DIVE Online developer to view the current configuration for a specific Integeration ID.

The differences between an Auth and Unauth configuration is that the UnAuth configuration does not require a bearer token. Only passing in the accountProfileId and integrationId is sufficient to retrieve the configuration settings.

The integrationId is the token from the Domains/Bundles created in the DIVE Online Web Portal.

api/v2/public/Integrations/{integrationId}/Configuration

[GET] api/v2/public/Integrations/{integrationId}/Configuration

Use Case - Retrieve the configuration details for a specific integration.

Token - public API token (pk_) or secret API Token (sk)

Required Parameters

integrationId - The unique identifier for the integration.

Optional Parameters None

Request Body None

Response Body


  "cssStyles": "string",
  "cssVariables": "string",
  "jsonSettings": "string",
  "showConsentForm": true,
  "consentText": "string",
  "checkboxText": "string",
  "showQrCode": true
}

Response Fields

cssStyles - Custom CSS styles for the integration.
cssVariables - CSS variables for theming the integration.
jsonSettings - JSON formatted settings specific to the integration.
showConsentForm - Boolean indicating if a consent form should be displayed.
consentText - Text to be displayed in the consent form.
checkboxText - Text for the consent checkbox.
showQrCode - Boolean indicating if a QR code should be displayed.

api/v2/public/Integrations/{integrationId}/UnauthConfiguration

[GET] api/v2/public/Integrations/{integrationId}/UnauthConfiguration