Tabla de contenidos
- Introducción
- Entendiendo las integraciones nativas
- Creación de una integración
- Detalles del formulario de integración
- Creación de una integración de producto
- Después de la creación de la integración
- Ver y administrar integraciones
- Integraciones de cuentas conectables
- Insignia de la comunidad e integraciones de la comunidad
- Prácticas recomendadas del flujo de instalación
- [Soporte de integración] (#integration-support)
- Conclusión
I. INTRODUCCIÓN 1 - 2 3
La integración con Esadax ofrece una manera poderosa de mejorar su aplicación o servicio. Ya sea que estés compilando para uso interno o publicando una herramienta para otros, esta guía te guiará a través de cada paso de la creación, administración y optimización de tu integración, con prácticas recomendadas para garantizar una experiencia fluida para tus usuarios.
Comprender las integraciones nativas
Las integraciones nativas son ciudadanos de primera clase en el ecosistema de Esadax, ofreciendo una integración directa y perfecta con las características de la plataforma.
Beneficios clave:
- No se requiere middleware — Soporte nativo desde la plataforma Esadax.
- Menor tiempo de desarrollo — Componentes prediseñados y configuración simplificada.
- Experiencia de desarrollador más sólida: documentación completa y soporte de plataforma.
También puede optar por crear integraciones personalizadas si su caso de uso requiere servicios externos o API.
Crear una integración
Para empezar:
- Ve a la Consola de Integraciones.
- Haz clic en Crear integración.
- Rellene el formulario con la información básica de su integración (consulte la siguiente sección).
Detalles del formulario de integración
Al llenar el formulario de integración, proporcione:
- Nombre: Un identificador único para tu integración.
- Descripción: Una breve explicación de lo que hace tu integración.
- Tipo de integración: Elige entre “Nativo” y “Personalizado”.
- Configuración de visibilidad: Defina quién puede ver o usar la integración.
- Correo electrónico de soporte: Proporcione los detalles de contacto para obtener soporte.
- Enlace de documentación (opcional): Ayuda a los usuarios a entender cómo instalarlo y usarlo.
- Botón de implementación (opcional): añade un botón para implementar automáticamente la integración desde Git.
Creación de una integración de producto
Cuando su integración implica un producto instalable, debe:
- Proporcione un flujo de instalación claro que se adapte tanto a los usuarios nuevos como a los existentes.
- Incluir documentación concisa para la instalación y el uso.
- Defina configuraciones predeterminadas que funcionen de inmediato y que a la vez permitan la personalización.
- Usa versionamiento en tu formulario para ayudar a rastrear actualizaciones y compatibilidad con versiones anteriores.
Creación después de la integración
Una vez publicado, puedes:
- Supervise los registros usando el botón Ver registros en la Consola de integraciones.
- Estado de actualización: realice un seguimiento de las métricas de instalación, los errores y los cambios de versión.
- Perfecciona tu integración: Itera en función de los comentarios o las pruebas de los usuarios.
Ver y administrar integraciones
En la Consola de Integraciones, puedes:
- Vea una lista de sus integraciones.
- Acceda a detalles, como URL activas, registros de instalación y estado de visibilidad.
- Filtre los registros por tipo de solicitud (por ejemplo, errores, instalaciones).
Integraciones de cuentas conectables
Si tu integración conecta servicios externos (por ejemplo, análisis, autenticación, comercio electrónico):
- Habilite flujos de trabajo seguros de vinculación de cuentas.
- Soporte escenarios de cuentas múltiples (individual vs. org).
- Validar tokens e identidades según el modelo de seguridad compartida de Esadax.
Insignia de la comunidad e integraciones de la comunidad
- Las integraciones enviadas por desarrolladores externos reciben una insignia de la comunidad, que las marca como compatibles con terceros.
- Estos pueden aparecer en el mercado con una etiqueta clara.
- Antes de instalar una integración de la comunidad, los usuarios deben revisar lo siguiente del desarrollador:
- Política de privacidad
- Términos y Condiciones de uso
- Detalles de soporte
Mejores prácticas de flujo de instalación
Diseñar una experiencia de instalación intuitiva mejora la adopción.
Flujo de aire recomendado:
- Nuevos usuarios:
- Guía a través de la creación de cuentas dentro del proceso de instalación.
- Usuarios que regresan:
- Permitir el inicio de sesión sin problemas sin perder el progreso de la instalación.
- Recuperación de errores:
- Maneje con gracia los restablecimientos de contraseña y las sesiones caducadas.
- Valores por defecto:
- Preconfigure ajustes sensatos para minimizar la entrada requerida.
- Opciones avanzadas:
- Proporciónalas, pero guárdalas detrás de una sección desplegable o expandible.
Soporte de integración
Usted es responsable del soporte continuo de su integración:
- Responda rápidamente a los problemas a través de su correo electrónico de soporte.
- Incluya consejos de solución de problemas y limitaciones conocidas en su documentación.
- Considere la posibilidad de configurar registros de cambios con versiones para comunicar las actualizaciones claramente.
IV. Conclusión
Siguiendo esta guía, puede entregar una integración confiable y fácil de usar para la plataforma Esadax. Ya sea que estés extendiendo flujos de trabajo internos o creando herramientas para la comunidad, un diseño de integración bien pensado, desde la estructura del formulario hasta el flujo del usuario, garantiza que tu trabajo sea exitoso y escalable.
