API Composer

Gegevens ophalen of doorgeven via een API.

Waar wil je mee aan de slag?

Op deze pagina

In API Composer configureer je aanroepen naar andere systemen en bepaal je wat er met de response gebeurt. Je beschrijft een call één keer — adres, authenticatie, te versturen records en gewenste velden uit de response — waarna deze handmatig, als onderdeel van een sequence of automatisch door het platform kan worden uitgevoerd.

Drie onderdelen vormen de basis:

Een request is één call naar één adres.
Een sequence is een reeks requests die in volgorde draait en waarden aan elkaar kan doorgeven.
Een environment bevat adressen, credentials en headers die verschillen tussen bijvoorbeeld test en productie, zodat dezelfde requests op meerdere omgevingen kunnen worden gebruikt.

Een response kan naar een data set in het platform worden geschreven of als waarde beschikbaar blijven voor latere requests in dezelfde sequence.

Gebruik API Composer wanneer

Service Automation Suite data uit een externe REST API moet lezen;
opgeslagen records naar een ander systeem moeten worden gestuurd;
meerdere calls in vaste volgorde moeten draaien;
waarden uit één call nodig zijn in latere calls;
API-configuratie tussen Service Automation Suite-systemen moet worden verplaatst.

Documentatieoverzicht

Onderwerp	Wat je vindt
de afgeschermde handleiding	Maak en voer je eerste request uit.
de afgeschermde handleiding	Collections, folders, requests en sequences.
de afgeschermde handleiding	Hergebruik hosts, headers, variabelen en credentials.
de afgeschermde handleiding	Test calls en bereid te versturen records voor.
de afgeschermde handleiding	Batching, paging, fouten, retries en polling.
de afgeschermde handleiding	Sla response-rows op of geef waarden door tussen requests.
de afgeschermde handleiding	Voer geconfigureerd werk uit en publiceer het.
de afgeschermde handleiding	Verplaats overdraagbare configuratie tussen systemen.
de afgeschermde handleiding	Procedures vanuit een gewenst resultaat.
de afgeschermde handleiding	Fouten, limieten en FAQ.

In deze sectie

Volledige documentatie

de afgeschermde handleiding

Samen verder met Service Automation Suite.

Vragen over jouw toepassing? We denken graag met je mee.

Bespreek jouw vraag →serviceautomation.eu+31 318 894 615

Waar kunnen we je mee helpen?