Integration Prerequisites¶
Requirements for connecting platforms to Dxtra.
Core Requirements¶
Before connecting any integration:
- Dxtra account with admin access -- You need admin privileges to configure integrations
- Data Controller DID -- Generated during account setup. Find it in Developers in the dashboard
- DX Key -- Your integration authentication key, also in Developers
- Platform admin access -- You need admin access to the platform you are connecting
Platform-Specific Requirements¶
E-commerce¶
Platform-Specific Requirements: - [x] Active Subscription - Valid subscription to the service you want to integrate - [x] API Access - Platform-specific API credentials or OAuth applications - [x] Webhook Support - Platform supports outbound webhooks (most do) - [x] Domain Verification - Ability to verify domain ownership where required
Core Platform Requirements¶
Account Requirements
Your Dxtra account must be properly configured before setting up any integrations.
Account Checklist:
- Active Account - Dxtra account with admin privileges
- Domain Verification - Your business domain registered and verified
- Data Controller DID - Unique decentralized identifier created
- API Credentials - Generated from Dxtra Dashboard Settings
- Security Settings - Two-factor authentication enabled (recommended)
Getting Your Data Controller DID: 1. Navigate to Dxtra Dashboard → Settings → Data Controllers 2. Complete organization information and domain verification 3. Copy your Data Controller DID (format: did:dep:controller:{uuid}) 4. This DID is required for all integration configurations
Supported Browsers
Dxtra Dashboard works best with modern, up-to-date web browsers.
Recommended Browsers:
| Browser | Minimum Version | Recommended |
|---|---|---|
| Google Chrome | 90+ | Latest |
| Mozilla Firefox | 88+ | Latest |
| Safari | 14+ | Latest |
| Microsoft Edge | 90+ | Latest |
Browser Features Required: - [x] JavaScript Enabled - Required for dashboard functionality - [x] Cookies Enabled - For session management and authentication - [x] TLS 1.2+ - Secure connection support - [x] WebSocket Support - For real-time integration monitoring
Security Standards
All Dxtra integrations implement enterprise-grade security requirements.
Security Checklist:
- HTTPS Required - All webhook endpoints must use SSL/TLS encryption
- Valid SSL Certificate - Proper SSL certificate on your domain
- API Key Management - Secure storage of API credentials
- Webhook Signatures - Cryptographic verification support
- Network Access - Allow Dxtra webhook delivery
Network Configuration:
Developer Requirements¶
Custom Integration Development
Requirements for building custom integrations using Dxtra's GraphQL API.
API Development Checklist:
- GraphQL Knowledge - Understanding of GraphQL queries and mutations
- API Authentication - Valid API key from Dxtra Dashboard Settings
- Webhook Handling - Ability to receive and process webhook events
- Testing Environment - Local development setup mirroring production
- Security Implementation - HMAC signature verification
Development Environment:
Privacy Widget Requirements
Requirements for embedding Dxtra privacy widgets on your website.
Website Requirements:
- HTML5 Website - Modern HTML5 compliant website
- JavaScript Support - JavaScript enabled for widget functionality
- Responsive Design - Mobile-friendly layout (recommended)
- Content Security Policy - Allow Dxtra widget domains if CSP is used
- Cookie Management - Ability to set privacy preference cookies
Widget Integration:
Platform-Specific Requirements¶
E-commerce Platforms¶
Prerequisites: - [x] Active Shopify Store - Plus, Advanced, or Basic Shopify subscription - [x] Admin Access - Shopify store admin or staff account with app installation permissions - [x] App Installation Rights - Ability to install third-party apps - [x] Webhook Configuration - Access to webhook settings (automatic for most setups)
Store Settings: - Store must be active (not development/password-protected) - Custom domain recommended (but not required) - HTTPS enabled (standard for all Shopify stores)
- Self-hosted WordPress installation (WordPress.com not supported)
- WooCommerce plugin installed and active
- WordPress administrator privileges
- WooCommerce REST API enabled
- SSL certificate on your WordPress site
Payments¶
- Active Stripe account (live mode, not just test mode)
- Access to Stripe Dashboard webhook settings
- Ability to create and manage webhooks
- QuickBooks Online subscription (not QuickBooks Desktop)
- QuickBooks Online admin privileges
- Intuit Developer account for OAuth app creation
Email Marketing¶
- Active Mailchimp account with API access
- API key generation permissions
- Access to webhook settings (Mandrill)
- Klaviyo subscription with API access
- Both private and public API keys
- Administrative access to Klaviyo account
Events and Surveys¶
- Active Eventbrite organizer account
- OAuth application setup in Eventbrite
- Event data access permissions
- Active subscription with API access
- API credentials
- Webhook configuration permissions
Security Requirements¶
All integrations require:
- HTTPS -- All webhook endpoints must use SSL/TLS encryption
- Valid SSL certificate -- Required for secure webhook delivery
- Network access -- Allow inbound HTTPS (port 443) from Dxtra webhook delivery
Widget Embedding Requirements¶
If you are embedding the Transparency Center widget on your website:
- HTML5 website with JavaScript enabled
- HTTPS enabled
- Content Security Policy (if used) must allow
transparencycenter.dxtra.ai
<!-- Widget script -->
<script src="https://transparencycenter.dxtra.ai/assets/index.js" type="module"></script>
<!-- Content Security Policy (if used) -->
<meta http-equiv="Content-Security-Policy"
content="script-src 'self' transparencycenter.dxtra.ai;">
Related Documentation¶
- First Integration -- Step-by-step setup guide
- All Integrations -- Available platforms
- Webhook Security -- Webhook authentication details
For help with prerequisites, contact support@dxtra.ai.