SDK de iOS
Actualizado el
El SDK de iOS de ChatFrom pone tu chatbot dentro de tu propia app para iPhone y iPad: una burbuja de chat en una esquina o una fila en una lista. Al tocarla, se abre el chat, a pantalla completa en el iPhone y como tarjeta en el iPad, con el mismo conocimiento, las mismas herramientas y los mismos flujos de trabajo que en tu sitio web, y todas las conversaciones en el mismo registro.
Cómo funciona
La burbuja y el encabezado del chat los dibuja la propia app, con el color, el ícono, el tamaño y la esquina que elegiste en Deploy. El chat que hay dentro es la propia página de chat de ChatFrom, así que lo que mejora allí llega a tu app sin publicar una nueva versión. Las personas pueden adjuntar archivos, seguir enlaces (que se abren fuera de tu app) y continuar donde lo dejaron.
El chat necesita iOS 16.4 o posterior. El paquete puede ir en una app que todavía es compatible con iOS 15: en un dispositivo con una versión anterior a iOS 16.4 no muestra burbuja y sus filas aparecen en gris, y ChatFrom.isSupported indica en qué caso está cada dispositivo.
Antes de empezar
- En ChatFrom, abre tu chatbot, ve a Deploy y activa Mobile apps. Luego publícalo. Un chatbot que no está en vivo, o que no está abierto a las apps, no muestra burbuja.
- Copia el ID del chatbot de su dirección en el panel: la parte que va después de
/dashboard/.
Cualquiera que tenga el ID de un chatbot puede chatear con él desde una app, como con su enlace para compartir, así que solo debería responder con información que mostrarías al público.
Agrega el paquete
En Xcode, elige File > Add Package Dependencies, escribe https://github.com/rouzbeh-abadi/chatfrom-ios, configura la regla como Up to Next Minor Version, ya que antes de la 1.0 una versión menor puede cambiar la API, y agrega la biblioteca ChatFromSDK a tu app. O en Package.swift:
Muestra la burbuja
Una línea al iniciar tu app, en application(_:didFinishLaunchingWithOptions:) o en el init() de tu App de SwiftUI:
- La burbuja se coloca sola sobre una barra de pestañas y se aparta mientras el teclado ocupa su lugar. Las pantallas que presenta tu app la cubren.
- Para una barra propia que aparece y desaparece, como un reproductor o un temporizador,
ChatFrom.setBottomInset(_:)aparta la burbuja de su camino. ChatFrom.setBubbleHidden(true)la oculta en una pantalla donde estorbaría, como tu propia pantalla de bloqueo o una pantalla de bienvenida, yChatFrom.stop()la quita.- Un chatbot que muestra la barra de entrada en tu sitio web sigue mostrando una burbuja en una app, como la configuran los ajustes de la burbuja en Deploy.
O agrega una fila
En SwiftUI, dentro de List o Form:
En UIKit, ChatFromCell es la misma fila para una vista de tabla, y ChatFromButton para cualquier otro lugar. Para abrir el chat desde algo propio, como una opción de menú, llama a ChatFrom.open(botId:). Una fila aparece en gris mientras el chatbot no está en vivo.
Personas con sesión iniciada
Si las personas inician sesión en tu app, indica quién la está usando, para que la siguiente persona en un dispositivo compartido no vea el chat de la anterior:
userIdes el ID que tu app da a la persona. Solo se usa una huella de ese ID, y se queda en el dispositivo.userTokenes opcional, para un chatbot cuyas herramientas actúan en nombre del usuario con sesión iniciada, como en tu sitio web. Obtenlo de tu propio servidor y nunca lo firmes en la app. Solo llega a los servidores de herramientas que marcaste para recibirlo.
Preguntas sobre suscripciones
Con RevenueCat conectado en Tools, los clientes pueden preguntarle al chatbot por su propia suscripción, a partir de la versión 0.2.0 del paquete. Tu app indica quién pregunta: con un token de tu servidor como el userToken de arriba, con el ID anónimo de RevenueCat o con la confirmación del propio App Store sobre las suscripciones.
Vuelve a configurar el ID de RevenueCat cada vez que cambie. ChatFrom.logout() lo olvida, así que después configura el del siguiente cliente. Solo se transmiten los identificadores anónimos de RevenueCat: para un cliente que inició sesión, usa un token.
Lo que tiene que hacer tu app
- Consentimiento. Las respuestas vienen de un modelo de IA a través de ChatFrom, así que te toca cumplir la regla de revisión de apps de Apple sobre compartir datos personales con la IA de un tercero (directriz 5.1.2(i)): indícalo en tu app y obtén el consentimiento antes de que alguien use el chat por primera vez. La burbuja y las filas cargan la página del chat y la abren al tocarlas, así que llama a
ChatFrom.start, o muestra una fila, solo cuando ya tengas ese consentimiento. Para pedirlo en el momento del toque, usa un botón propio que pregunte primero y luego llame aChatFrom.open(botId:). - Privacidad. Tu aviso de privacidad tiene que cubrir lo que las personas le escriben al chatbot y lo que piden sus herramientas, como un nombre, una dirección de correo electrónico o un número de teléfono para programar una llamada. El manifiesto de privacidad del SDK declara estos datos, y también el historial de compras que lee el chat cuando compartes las suscripciones del App Store. Lo que el chat guarda en el dispositivo depende de Remember returning visitors en Deploy: se conserva entre un arranque y otro de la app cuando está activado, y solo mientras la app sigue abierta cuando está desactivado.
- La cámara. El selector de archivos puede ofrecer tomar una foto, así que agrega
NSCameraUsageDescriptiona tuInfo.plist. - App-Bound Domains. Si tu
Info.plistincluyeWKAppBoundDomains, agregachatfrom.ioa esa lista, o el chat no podrá cargarse.
Las respuestas en una app usan tus créditos mensuales, igual que en tu sitio web.
El README del SDK tiene todas las llamadas y opciones. Para poner el mismo chatbot en tu sitio web, consulta la guía Primeros pasos.