Zum Hauptinhalt springen

iOS-App

Dieser Leitfaden richtet sich an Entwickler, die die LeadHub iOS-Begleit-App erstellen oder anpassen. Der App-Quellcode ist in Swift geschrieben und zielt auf iPhone und iPad ab.

Anforderungen​

  • Xcode 15 oder neuer (nur macOS)
  • Swift 5.9 oder neuer
  • iOS-Deployment-Ziel: mindestens iOS 15.0
  • Ein Apple Developer-Konto (erforderlich für TestFlight und App Store-Verteilung)
  • Eine LeadHub-Instanz mit einer gültigen HTTPS-URL und einem aktiven API-Schlüssel

Projekteinrichtung​

  1. Öffnen Sie den Ordner ios/ aus Ihrem LeadHub-Kauf in Xcode.
  2. Öffnen Sie die Datei .xcworkspace (nicht .xcodeproj), falls CocoaPods- oder Swift Package Manager-Abhängigkeiten vorhanden sind.
  3. Wählen Sie Ihr Entwicklungsteam in den Signing & Capabilities-Einstellungen des Projekts aus.
  4. Erstellen Sie die App und führen Sie sie auf einem Simulator oder Gerät aus.

Architektur​

Die App verwendet eine standardmäßige iOS-Architektur:

  • URLSession mit einem benutzerdefinierten API-Client für HTTP-Aufrufe an die LeadHub REST API
  • Combine oder async/await für asynchrone Operationen
  • SwiftUI für die Benutzeroberfläche
  • CoreData für das lokale Caching von Leads zwischen Sitzungen
  • Apple Push Notification Service (APNs) für Push-Benachrichtigungen

API-Schlüssel werden im iOS Keychain mithilfe des Security-Frameworks gespeichert.

Authentifizierungsablauf​

  1. Der Benutzer gibt die URL seiner LeadHub-Instanz und den API-Schlüssel auf dem Onboarding-Bildschirm ein.
  2. Die App stellt eine GET /api/v1/health-Anfrage, um zu prüfen, ob die Instanz über HTTPS erreichbar ist.
  3. Sie prüft die Gültigkeit des API-Schlüssels durch eine authentifizierte Testanfrage.
  4. Die URL und der API-Schlüssel werden im Keychain gespeichert.

Push-Benachrichtigungen​

Push-Benachrichtigungen verwenden den Apple Push Notification Service (APNs).

  1. Erstellen Sie in Ihrem Apple Developer-Konto einen APNs-Schlüssel (.p8-Datei) unter Certificates, Identifiers & Profiles → Keys.
  2. Notieren Sie die Key-ID und Ihre Team-ID.
  3. Legen Sie in der Konfiguration Ihres LeadHub-Backends APNS_KEY, APNS_KEY_ID, APNS_TEAM_ID und APNS_BUNDLE_ID fest.
  4. Aktivieren Sie in Xcode die Push Notifications-Funktion unter Signing & Capabilities.

Die App registriert sich beim ersten Start für Push-Benachrichtigungen und sendet das Geräte-Token über die API an das LeadHub-Backend.

Für die Verteilung erstellen​

  1. Archivieren Sie die App über Product → Archive in Xcode.
  2. Klicken Sie im Organizer-Fenster auf Distribute App.
  3. Wählen Sie App Store Connect für die App Store-Verteilung oder TestFlight für Betatests.
  4. Folgen Sie den Xcode-Anweisungen zum Hochladen.

Verwendete API-Endpunkte​

EndpunktZweck
GET /api/v1/healthInstanzverbindung überprüfen
GET /api/v1/leadsLead-Liste laden
GET /api/v1/leads/{id}Lead-Details laden
PATCH /api/v1/leads/{id}Lead-Status oder -Stufe aktualisieren
POST /api/v1/leads/{id}/tagsTag zu Lead hinzufügen
GET /api/v1/pipelinesPipeline-Liste für die Stufenauswahl laden

Mindestens erforderliche API-Schlüssel-Bereiche​

BereichGrund
read:leadsLeads anzeigen
write:leadsLead-Status, Stufe und Tags aktualisieren
read:pipelinesPipeline-Stufenauswahl befüllen

App Store Datenschutzangaben​

Deklarieren Sie beim Einreichen im App Store in Ihrem App Privacy-Bereich die folgende Datennutzung:

  • Kontaktinformationen (E-Mail, Telefon) — von Leads erfasst, nicht von Benutzern
  • Identifikatoren (API-Schlüssel) — mit dem Benutzer verknüpft, zur Authentifizierung verwendet
  • Nutzungsdaten — werden nicht erfasst