/
Creazione e pubblicazione di integrazioni su Esadax
Indice dei contenuti
- [Introduzione] (#introduction)
- Capire le integrazioni native
- Creazione di un'integrazione
- Dettagli modulo di integrazione
- Creazione di un'integrazione di prodotto
- Dopo la creazione dell'integrazione
- Visualizzazione e gestione delle integrazioni
- Integrazioni di account collegabili
- Distintivo della comunità e integrazioni della comunità
- Procedure consigliate per il flusso di installazione
- [Supporto di integrazione] (#integration-support)
- Conclusione
Introduzione
L'integrazione con Esadax offre un modo potente per migliorare la tua applicazione o servizio. Che tu stia creando per uso interno o pubblicando uno strumento per altri, questa guida ti guiderà attraverso ogni passaggio della creazione, gestione e ottimizzazione della tua integrazione, con best practice per garantire un'esperienza fluida per i tuoi utenti.
Comprendere le integrazioni native
Le integrazioni native sono cittadini di prima classe nell'ecosistema Esadax, offrendo un'integrazione diretta e senza soluzione di continuità con le funzionalità della piattaforma.
Vantaggi principali:
- Nessun middleware richiesto — Supporto nativo dall’interno della piattaforma Esadax.
- Tempi di sviluppo ridotti — Componenti precostituiti e configurazione semplificata.
- Esperienza di sviluppo più solida — Documentazione completa e supporto della piattaforma.
Puoi anche scegliere di creare integrazioni personalizzate se il tuo caso d'uso richiede servizi esterni o API.
Creare un'integrazione
Per iniziare:
- Vai alla Console Integrazioni.
- Fai clic su Crea integrazione.
- Compila il modulo con le informazioni di base della tua integrazione (vedi sezione successiva).
Modulo di integrazione Dettagli
Quando si compila il modulo di integrazione, fornire:
- Nome: un identificatore univoco per la tua integrazione.
- Descrizione: una breve spiegazione di cosa fa la tua integrazione.
- Tipo di integrazione: scegli tra “Nativo” e “Personalizzato”.
- Impostazioni di visibilità: definisci chi può vedere o utilizzare l'integrazione.
- E-mail di supporto: fornire i dettagli di contatto per il supporto.
- Link alla documentazione (facoltativo): aiuta gli utenti a capire come installarlo e utilizzarlo.
- Pulsante di distribuzione (facoltativo): aggiungi un pulsante per distribuire automaticamente l'integrazione da Git.
Creazione di un'integrazione di prodotto
Quando l'integrazione prevede un prodotto installabile, è necessario:
- Fornire un chiaro flusso di installazione che soddisfi sia gli utenti nuovi che quelli esistenti.
- Includi una breve documentazione per l'installazione e l'uso.
- Definisci impostazioni predefinite che funzionano immediatamente, pur consentendo la personalizzazione.
- Usa versioning nel modulo per tenere traccia degli aggiornamenti e della compatibilità con le versioni precedenti.
Creazione dopo l'integrazione
Una volta pubblicato, puoi:
- Monitorare i registri utilizzando il pulsante Visualizza registri nella Console integrazioni.
- Stato dell'aggiornamento: monitora le metriche di installazione, gli errori e le modifiche alla versione.
- Perfeziona la tua integrazione: Itera in base al feedback degli utenti o ai test.
Visualizzazione e gestione delle integrazioni
Nella Console Integrazioni, puoi:
- Visualizza un elenco delle tue integrazioni.
- Accedi a dettagli, inclusi URL attivi, log di installazione e stato di visibilità.
- Filtra i log in base al tipo di richiesta (ad esempio, errori, installazioni).
Integrazioni di account collegabili
Se la tua integrazione collega servizi esterni (ad esempio, analisi, autenticazione, e-commerce):
- Abilita flussi di lavoro sicuri collegamento account.
- Supporto scenari multi-account (individuale vs. Il farmaco deve essere somministrato per via endovenosa (vedere paragrafo 5.2).
- Convalidare token e identità secondo il modello di sicurezza condivisa di Esadax.
Badge della comunità e integrazioni della comunità
- Le integrazioni inviate da sviluppatori esterni ricevono un badge della community, che le contrassegna come supportate da terze parti.
- Questi possono apparire nel mercato con un'etichetta chiara.
- Prima di installare un'integrazione della community, gli utenti devono esaminare le seguenti informazioni dello sviluppatore:
- Informativa sulla privacy
- Condizioni di utilizzo
- Dettagli di supporto
Best practice per il flusso di installazione
Progettare un'esperienza di installazione intuitiva migliora l'adozione.
Consigliato di flusso:
- Nuovi utenti:
- Guida alla creazione dell'account all'interno del processo di installazione.
- Utenti di ritorno:
- Consenti l'accesso senza soluzione di continuità senza perdere l'avanzamento dell'installazione.
- Recupero degli errori:
- Gestisci con grazia i reset delle password e le sessioni scadute.
- Impostazioni predefinite:
- Preconfigurare le impostazioni ragionevoli per ridurre al minimo l'input richiesto.
- Opzioni avanzate:
- Forniscili, ma nascondeteli dietro una sezione attivabile o espandibile.
Supporto per l'integrazione
Sei responsabile del supporto continuo della tua integrazione:
- Rispondi prontamente ai problemi tramite la tua email di supporto.
- Includi nella documentazione suggerimenti per la risoluzione dei problemi e limitazioni note.
- Prendi in considerazione l'impostazione di changelog versionati per comunicare chiaramente gli aggiornamenti.
Conclusione
Seguendo questa guida, è possibile fornire un'integrazione affidabile e facile da usare per la piattaforma Esadax. Che tu stia estendendo i flussi di lavoro interni o creando strumenti per la community, una progettazione dell'integrazione ponderata, dalla struttura del modulo al flusso utente, garantisce che il tuo lavoro abbia successo e sia scalabile.
