Keyda Business
AustriaEnglish Anmelden Kostenlos starten
Keyda Business DokumentationReferenz

SDK-Referenz

Jedes Keyda SDK – Android, iOS, React Native, Flutter, Ionic – implementiert denselben kompakten Vertrag. Wenn Sie eines verwendet haben, kennen Sie alle.

Die API

AnrufWas es tut
init / initializeSpeichert Ihre Client ID. Validiert sie und gibt eine deutliche Fehlermeldung aus, falls sie fehlerhaft ist.
showPräsentiert den Chat über Ihrer App.
dismissSchließt es.
isShowingOb es gerade angezeigt wird.

Es gibt bewusst nichts anderes. Keine API zum Senden von Nachrichten, keine Anzeige ungelesener Nachrichten, kein Aufruf zur Benutzeridentität – da all dies noch nicht durchgängig funktioniert, und eine Methode, die nicht funktioniert, ist schlimmer als eine, die fehlt.

Die URL, die jedes SDK öffnet

{baseUrl}/chat/{clientId}

baseUrl ist standardmäßig auf https://keyda.in/business eingestellt und kann auf jeder Plattform für Staging oder eine selbst gehostete Installation überschrieben werden.

Warum eine Web-Ansicht und was sie Sie kostet

Es gibt eine einzige Chat-Oberfläche, die von der Plattform bereitgestellt und von jedem Kanal geladen wird.

Was Sie erhalten: Änderungen, die ein Inhaber im Dashboard vornimmt – Akzentfarbe, Begrüßungsnachricht, Bot-Name, Live-Schaltung – erreichen sofort jede App, ohne dass ein Release erforderlich ist. Eine Korrektur wird überall gleichzeitig wirksam. Der Chat ist über alle Plattformen hinweg identisch.

Was es kostet: der Chat benötigt eine Verbindung. Es gibt keinen Offline-Modus und noch keine Push-Benachrichtigungen.

Wir möchten, dass Sie dies vor der Veröffentlichung wissen, anstatt es erst danach zu entdecken.

Garantien, die jedes SDK bietet

  1. Navigation entweicht. Ein Link zu einem anderen Ursprung öffnet sich im Systembrowser, anstatt den Chat zu ersetzen. Ohne dies beendet ein einziger Klick auf einen Footer-Link das Gespräch des Kunden ohne Rückweg.
  2. Konversationsfortführung. Der DOM-Speicher ist aktiviert, sodass Kunden, die die App schließen und zurückkehren, ihren Chatverlauf dort vorfinden, wo sie ihn verlassen haben (für 24 Stunden).
  3. Die Tastatur verdeckt niemals das Eingabefeld.
  4. Sicherheitsbereiche werden respektiert – kein Chat wird unter einer Notch oder einem Home-Indikator angezeigt.
  5. Kein Absturz erreicht Ihre App. Ein fehlgeschlagener Ladevorgang zeigt eine Wiederholungsoption an.
  6. Keine Analysen, keine Gerätekennungen, keine Abhängigkeiten von Drittanbietern. Das Hinzufügen eines Keyda SDK fügt Ihrer App keinen Tracker hinzu.

Format der Client ID

kb_live_ followed by 8-48 hexadecimal characters

Alles andere wird bei der Initialisierung abgelehnt, anstatt einen 404-Fehler vor dem Kunden anzuzeigen. Die Client ID ist konzeptbedingt öffentlich — sie ist auf jeder Website sichtbar, die das Widget einbindet — und bietet keine Möglichkeit, Ihr Konto zu lesen oder zu ändern. Siehe Limits und Sicherheit.

Quelle

Öffentlich, MIT-lizenziert: github.com/KeydaAI/keyda-business-sdks. Der gemeinsame Vertrag, an den jedes Paket gebunden ist, befindet sich in CONTRACT.md oben in diesem Repository.

Next: Limits and security →