Documentatie op maat voor REST API vanuit AllSolutions genereren

AllSolutions12 bevat een universele software koppeling, een REST API. Deze maakt van AllSolutions een volledig open platform, waarin je veilig en snel data uitwisselt met andere systemen. Via de consultant is documentatie beschikbaar voor het activeren en inrichten van de REST API in AllSolutions.

Ter aanvulling op de standaard documentatie is het nu ook mogelijk om documentatie op maat vanuit jouw eigen omgeving te genereren. Dit kun je gebruiken zodra de REST API in jouw omgeving is geactiveerd en de voor de API benodigde weergaven en instellingen zijn ingericht.

De documentatie kun je genereren vanuit de Interfaces (MINTFA). (In deze functie worden alle koppelingen met de omgeving vastgelegd.) Selecteer hier de REST API koppeling, gebruik de actie REST API documentatie genereren en klik op Starten. (Je kunt eventueel ook de nieuwe functie Genereren Documentatie REST API (PINTFA) gebruiken. Hier selecteer je dan de bijbehorende interface en klikt op Starten.)

De documentatie is direct online beschikbaar. Je kunt deze inzien via de URL die het systeem automatisch hiervoor aanmaakt. Deze vind je in het veld Documentatie link bij de gegevens van de REST API in de functie Interfaces (MINTFA). En deze link kun je vervolgens weer gemakkelijk delen met de externe partij waarmee je de koppeling of app wilt realiseren.

Er wordt alleen documentatie gerealiseerd voor de functies die je via de REST API wilt ontsluiten. Met andere woorden, waarvoor je specifieke REST API instellingen en/of weergaven hebt aangemaakt. Voeg je op een later moment nieuwe weergaven of instellingen toe? Dan kun je gewoon nog een keer de actie gebruiken om de online documentatie gemakkelijk bij te werken met de meest recente gegevens.

Deze informatie behoort tot de volgende release(s): 12.0.02