Inhoudsopgave
- [Inleiding] (#introduction)
- Native integraties begrijpen
- Een integratie maken
- Integratieformulier Details
- Een productintegratie maken
- Na integratie aanmaken
- Integraties bekijken en beheren
- Verbindbare accountintegraties
- Communitybadge en community-integraties
- Aanbevolen procedures voor de installatiestroom
- [Ondersteuning voor integratie] (#integration-support)
- [Conclusie] (#conclusion)
Inleiding
Integratie met Esadax biedt een krachtige manier om uw applicatie of service te verbeteren. Of je nu bouwt voor intern gebruik of een tool publiceert voor anderen, deze handleiding leidt je door elke stap van het maken, beheren en optimaliseren van je integratie — met best practices om een soepele ervaring voor je gebruikers te garanderen.
Native integraties begrijpen
Native integraties zijn eersteklas burgers in het Esadax-ecosysteem en bieden directe en naadloze integratie met platformfuncties.
Belangrijkste voordelen:
- Geen middleware nodig — Native ondersteuning vanuit het Esadax platform.
- Minder ontwikkeltijd — Vooraf gebouwde componenten en vereenvoudigde installatie.
- Sterkere ontwikkelaarservaring — Volledige documentatie en platformondersteuning.
U kunt er ook voor kiezen om Aangepaste integraties te bouwen als uw use case externe services of API's vereist.
Een integratie maken
Om aan de slag te gaan:
- Ga naar de Integrations Console.
- Klik op Integratie maken.
- Vul het formulier in met de basisgegevens van uw integratie (zie de volgende sectie).
Integratieformulier details
Geef bij het invullen van het integratieformulier het volgende op:
- Naam: Een unieke ID voor uw integratie.
- Beschrijving: Een korte uitleg van wat uw integratie doet.
- Integratietype: Kies tussen "Native" en "Custom".
- Zichtbaarheidsinstellingen: Definieer wie de integratie kan zien of gebruiken.
- Ondersteuning E-mail: Geef contactgegevens voor ondersteuning.
- Documentatielink (optioneel): Help gebruikers te begrijpen hoe ze het moeten installeren en gebruiken.
- Knop Implementeren (optioneel): Voeg een knop toe om de integratie automatisch vanuit Git te implementeren.
Een productintegratie maken
Wanneer uw integratie een installeerbaar product omvat, moet u:
- Zorg voor een duidelijke installatiestroom die zowel nieuwe als bestaande gebruikers tegemoet komt.
- Inclusief beknopte documentatie voor installatie en gebruik.
- Definieer standaard instellingen die direct werken, terwijl aanpassingen nog steeds mogelijk zijn.
- Gebruik versiebeheer in uw formulier om updates en achterwaartse compatibiliteit bij te houden.
Na integratie Creatie
Eenmaal gepubliceerd, kunt u:
- Bewaak logs met behulp van de knop Logs bekijken in de Integrations Console.
- Updatestatus: Volg installatiestatistieken, fouten en versiewijzigingen.
- Verfijn uw integratie: Itereren op basis van feedback van gebruikers of testen.
Integraties bekijken en beheren
In de Integrations Console kunt u:
- Bekijk een lijst met uw integraties.
- Krijg toegang tot details, waaronder live URL's, installatielogboeken en zichtbaarheidsstatus.
- Filter logboeken op aanvraagtype (bijvoorbeeld fouten, installaties).
Aansluitbare accountintegraties
Als uw integratie externe services verbindt (bijvoorbeeld analyse, verificatie, e-commerce):
- Schakel veilige workflows voor accountkoppeling in.
- Ondersteuning scenario's met meerdere accounts (individueel vs. Zie rubriek 4.8 voor meer informatie.
- Valideer tokens en identiteiten volgens het gedeelde veiligheidsmodel van Esadax.
Communitybadge en community-integraties
- Integraties die door externe ontwikkelaars zijn ingediend, krijgen een Community-badge, waarmee ze worden gemarkeerd als ondersteund door derden.
- Deze mogen in de marktplaats verschijnen met een duidelijk label.
- Voordat een community-integratie wordt geïnstalleerd, moeten gebruikers het volgende van de ontwikkelaar bekijken:
- Algemene voorwaarden Privacybeleid
- Gebruiksvoorwaarden
- Details van de ondersteuning
Aanbevolen procedures voor de installatiestroom
Het ontwerpen van een intuïtieve installatie-ervaring verbetert de acceptatie.
De aanbevolen stroom:
- Nieuwe gebruikers:
- Begeleidt u bij het aanmaken van een account binnen het installatieproces.
- Terugkerende gebruikers:
- Maak naadloze aanmelding mogelijk zonder de installatievoortgang te verliezen.
- Fout herstel:
- Behandel wachtwoordherstel en verlopen sessies op een elegante manier.
- Standaardwaarden:
- Configureer vooraf zinvolle instellingen om de vereiste input te minimaliseren.
- Geavanceerde opties:
- Geef ze aan, maar verberg ze achter een uitklapbare sectie.
Ondersteuning voor integratie
U bent verantwoordelijk voor de doorlopende ondersteuning van uw integratie:
- Reageer snel op problemen via uw ondersteuningsmail.
- Neem tips voor het oplossen van problemen en bekende beperkingen op in uw documentatie.
- Overweeg het opzetten van versiegestuurde changelogs om updates duidelijk te communiceren.
Conclusie
Door deze gids te volgen, kunt u een betrouwbare en gebruiksvriendelijke integratie voor het Esadax-platform leveren. Of je nu interne workflows uitbreidt of tools bouwt voor de community, doordacht integratieontwerp — van formulierstructuur tot gebruikersstroom — zorgt ervoor dat je werk succesvol en schaalbaar is.
