Aloompa Presence Integration Guide - Third Party (Indoor + Outdoor)

📋 Pre-Integration Checklist:

• ☐ Console credentials and App Key received
  Provided by Aloompa team
• ☐ SDK integrated into mobile apps
  iOS (SPM/CocoaPods) and/or Android (Gradle)
• ☐ User alias configured
  setAlias("user_id", <unique-id>) called after login
• ☐ Indoor setup completed
  Beacons registered with UUID/Major/Minor (Console → Beacons)
• ☐ Outdoor setup completed
  Geofence regions created (Console → Regions)
• ☐ Push provider configured
  Alias Key = user_id (Console → Messaging ⚙)
• ☐ Testing completed
  Both indoor and outdoor smoke tests passing

🔐 Required Access & Tools

• Documentation: Crowd Connected Console & Documentation
• Development Environment: Xcode 15+ or Android Studio Hedgehog+
• SDK Version: Crowd Connected SDK 2.0+ (current version with enhanced debugging)
• Unique User ID: Stable identifier per user account

📡 Hardware Requirements

• Beacons: iBeacon or Eddystone compatible
• Test Hardware: Available from Aloompa if needed
• Mobile Devices: iOS 12+ / Android 7+

📱 Push Notification Support

Choose one of the following providers:

• OneSignal
• FCM/APNs
• AWS SNS/Pinpoint
• Custom webhook (Recommended)

import CrowdConnectedCore

// Initialize the SDK with required modules
CrowdConnected.start(
    apiKey: "APP_KEY",
    modules: [.geo, .ips]  // Note: .ips for indoor positioning, .geo for outdoor
)

// Set user alias after login (call after successful user authentication)
CrowdConnected.setAlias(key: "user_id", value: currentUser.id)

// Initialize the SDK with required modules
// Note: Use current SDK 2.0 class names and configuration
Colocator.Builder(this, "APP_KEY")
    .enableGeoModule()      // Outdoor positioning
    .enableIPSModule()      // Indoor positioning (IPS = Indoor Positioning System)
    .start()

// Set user alias after login (call after successful user authentication)
Colocator.setAlias("user_id", currentUser.id)

⚙️ Module Configuration

Choose the appropriate modules based on your use case:

Use Case	Module Configuration	Console Setup Required
Outdoor only	.enableGeoModule()	Draw GPS regions
Indoor only	.enableIPSModule()	Register beacons → Create regions
Indoor + Outdoor	Enable both modules	Configure both beacon and GPS regions

🔧 Endpoint Requirements:

• URL: POST https://yourdomain.com/crowdconnected
• Protocol: HTTPS required
• Response: Must return HTTP 200 for successful processing

{
    "title": "Notification Heading",
    "body": "Notification Message",
    "alias": "user_12345"
}

✅ Implementation Flow:

1. Verify the request (implement HMAC verification or IP allowlisting)
2. Map alias to user/device in your system
3. Send push notification via your chosen provider (FCM/APNs/etc.)
4. Return HTTP 200 status
5. Handle retries - system will retry on 5xx errors (max 3 attempts)

🌍 Outdoor Location Testing

Setup:

1. Navigate to Console → Regions
2. Draw a 5km region around your office
3. Create an "On entry" test message

Test Process: Walk outside boundary, then back in
Expected Result: Push notification within 10 seconds

🏢 Indoor Beacon Testing

Setup:

1. Power on a test beacon
2. Add beacon to Console (UUID/Major/Minor)
3. Create small region linked to beacon
4. Set up entry trigger message

Test Process: Walk away from beacon, then return
Expected Result: Push notification on beacon entry

🔍 Device Status & Remote Debugging (SDK 2.0):

• Device Status: Console → Developer Setup shows real-time connection status
• Remote Debug Mode: Use device IP address or Crowd Connected device ID
• Real-time Logs: SDK status changes and configuration issues visible in console
• Status Reports: Automatic reports include SDK version, modules, permissions

✅ Final Verification Checklist:

• ☐ Latest SDK version installed
• ☐ Required permissions granted (location, push notifications)
• ☐ Beacon UUID/Major/Minor values match Console registration
• ☐ Push tokens successfully registered with provider
• ☐ Console logs showing accurate user analytics

🆘 Primary Support - Aloompa

Contact: clientsupport@aloompa.com

• Integration assistance
• Implementation guidance
• Technical troubleshooting
• Account and credential support

🔧 Secondary Support - Crowd Connected

Portal: Crowd Connected Support

• SDK documentation
• API reference guides
• Platform-specific issues

🔧 Hardware & Testing

• Beacon Hardware: Request test beacons from Aloompa
• Build Verification: Submit test builds to Aloompa for verification
• Real Device Testing: Always test in actual deployment environments

✅ Best Practices

• Monitor Console analytics during initial deployment
• Keep SDK updated to latest stable version
• Implement proper error handling for location permissions
• Test with real devices in production-like conditions

⚠️ Important: Always test with real devices in actual deployment environments. Simulator testing is insufficient for location-based features.