/
Bygga och publicera integrationer på Esadax
Innehållsförteckning
- Introduktion
- Förstå inbyggda integrationer
- Skapa en integration
- Detaljer om integrationsformulär
- Skapa en produktintegrering
- Efter skapande av integration
- Visa och hantera integrationer
- Anslutbara kontointegreringar
- Community-märke och community-integreringar
- Bästa metoder för installationsflöde
- Stöd för integration
- Slutsats
Inledning
Integrering med Esadax erbjuder ett kraftfullt sätt att förbättra din applikation eller tjänst. Oavsett om du bygger för internt bruk eller publicerar ett verktyg för andra, kommer den här guiden att leda dig genom varje steg för att skapa, hantera och optimera din integration – med bästa praxis för att säkerställa en smidig upplevelse för dina användare.
Förstå inbyggda integrationer
Native integrationer är första klassens medborgare i Esadax ekosystem och erbjuder direkt och sömlös integration med plattformsfunktioner.
Viktiga fördelar:
- Ingen mellanvara krävs — Inbyggt stöd inifrån Esadax plattform.
- Kortare utvecklingstid – Förbyggda komponenter och förenklad konfiguration.
- Starkare utvecklarupplevelse – Fullständig dokumentation och plattformsstöd.
Du kan också välja att bygga Anpassade integrationer om ditt användningsfall kräver externa tjänster eller API:er.
Skapa en integration
Så här kommer du igång:
- Gå till Integrations Console.
- Klicka på Skapa integration.
- Fyll i formuläret med din integrations grundläggande information (se nästa avsnitt).
Detaljer om integrationsformulär
När du fyller i integrationsblanketten ska du uppge:
- Namn: En unik identifierare för din integration.
- Beskrivning: En kort förklaring av vad din integration gör.
- Integrationstyp: Välj mellan ”Inbyggd” och ”Anpassad”.
- Synlighetsinställningar: Definiera vem som kan se eller använda integrationen.
- Support Email: Ange kontaktuppgifter för support.
- Dokumentationslänk * (valfritt) *: Hjälp användarna att förstå hur man installerar och använder den.
- Distribuera knapp * (valfritt) *: Lägg till en knapp för att automatiskt distribuera integrationen från Git.
Skapa en produktintegration
När din integration omfattar en installerbar produkt bör du:
- Ge ett tydligt installationsflöde som rymmer både nya och befintliga användare.
- Inkludera kortfattad dokumentation för installation och användning.
- Definiera standardinställningar som fungerar direkt och som fortfarande kan anpassas.
- Använd versionshantering i formuläret för att spåra uppdateringar och bakåtkompatibilitet.
Efter integrationsskapande
När den är publicerad kan du:
- Övervaka loggar med hjälp av knappen Visa loggar i integrationskonsolen.
- Uppdateringsstatus: Spåra installationsmätvärden, fel och versionsändringar.
- Förfina din integration: Itera baserat på användarfeedback eller testning.
Visa och hantera integreringar
I Integrations Console kan du:
- Visa en lista över dina integreringar.
- Få tillgång till information, inklusive aktiva webbadresser, installationsloggar och synlighetsstatus.
- Filtrera loggar efter typ av begäran (t.ex. fel, installationer).
Anslutbara kontointegrationer
Om din integration ansluter externa tjänster (t.ex. analys, autentisering, e-handel):
- Aktivera säkra kontolänkande arbetsflöden.
- Stöd flera konton scenarier (enskilda vs. (se avsnitt 4. 4).
- Validera tokens och identiteter enligt Esadax delade säkerhetsmodell.
Community-märke och community-integreringar
- Integreringar som skickas in av externa utvecklare får ett Community-märke, vilket markerar att de stöds av tredje part.
- Dessa kan dyka upp på marknaden med en tydlig etikett.
- Innan du installerar en community-integration bör användarna granska utvecklarens:
- Allmänt om vår sekretesspolicy
- Användarvillkor
- Support detaljer
Bästa praxis för installationsflöde
Att utforma en intuitiv installationsupplevelse förbättrar antagandet.
Rekommenderat flöde:
- Nya användare:
- Guide genom skapande av konto inom installationsprocessen.
- Återkommande användare:
- Tillåt sömlös inloggning utan att förlora installationsförloppet.
- Återställning av fel:
- Hantera lösenordsåterställningar och utgångna sessioner på ett smidigt sätt.
- Standardvärden:
- Förkonfigurera vettiga inställningar för att minimera nödvändig inmatning.
- Avancerade alternativ:
- Tillhandahåll dem, men göm dem bakom ett växlingsbart eller expanderbart avsnitt.
Stöd för integration
Du ansvarar för löpande support av din integration:
- Svara snabbt på problem via din support-e-post.
- Inkludera felsökningstips och kända begränsningar i dokumentationen.
- Överväg att ställa in versionerade ändringsloggar för att kommunicera uppdateringar tydligt.
Slutsats
Genom att följa den här guiden kan du leverera en pålitlig och användarvänlig integration för Esadax-plattformen. Oavsett om du utökar interna arbetsflöden eller bygger verktyg för communityn säkerställer en genomtänkt integrationsdesign – från formulärstruktur till användarflöde – att ditt arbete blir framgångsrikt och skalbart.
