Custom Integration Protocol

Overview

Our custom integration protocol provides a unified and customizable authentication mechanism for different platforms. This system allows users to enter their credentials through a centralized form and authenticate against an external server. Once the user's identity is verified, an Auth Token is generated for access to the Publica.la platform.

Note: This is our recommended approach for custom integrations. While we still maintain legacy integrations like Arc XP for existing customers, new integrations should use this protocol.

Technical Implementation

Route Structure

• Routes are implemented with the prefix 'integrations'
• Pattern: /integrations/{tenant_id}/embeddable-login-ui
• Additional routes for specific messaging needs

Components

1. Livewire Components

   • Handles UI behavior and state
   • Manages communication with iFrame through postMessage
   • Contains specialized tenant integration logic

2. Views and Scripts

   • Located in resources\views\livewire\custom-integrations
   • JavaScript handlers in resources\js\custom-integrations
   • Manages UI interactions and iFrame communication

Integration Requirements

1. Initial Setup

   • Association with unique Publica.la tenant
   • Authentication via Auth Token
   • Unique user identifier system
   • External server authorization flow

2. Technical Requirements

   • External server endpoint URL
   • User validation data specification
   • Data validation prerequisites
   • Specified data format for server communication
   • Password change endpoint (if applicable)

3. Response Handling

   • User identification protocol
   • Expected HTTP status codes
   • Response format specification
   • Error handling and codes
   • Custom error messages

4. UI/UX Requirements

   • Logos and branding assets
   • Style guidelines and design specifications
   • Platform-specific requirements
   • Additional user information (Terms, FAQ, etc.)

Environment Configuration

Required environment variables:

PUB_CUSTOM_SIGN_IN=true
PUB_CUSTOM_SIGN_IN_URL='/integrations/{tenant_id}/embeddable-login-ui'

Security Considerations

• External server validates all access
• Unique user identifiers required
• Token-based authentication
• Secure communication channels

Integration Process

1. Initial Setup

   • Configure tenant in Publica.la
   • Set up environment variables
   • Implement required endpoints

2. Implementation

   • Embed login interface
   • Configure authentication flow
   • Set up error handling
   • Test user flows

3. Validation

   • Test authentication flows
   • Verify error handling
   • Confirm security measures
   • Validate user experience

Support

For detailed integration support or technical questions, please contact our development team.

---