Service Automation Suite Wiki · Product documentation
Practical knowledge from Service Automation Suite.
API Composer
Read or send data through an API.
On this page
API Composer is where you set up calls to other systems and decide what happens to what comes back. You describe a call once — its address, its authentication, the records it should send, the fields you want out of the response — and from then on it can be run by hand, run as part of a sequence of calls, or run automatically by the rest of the platform.
Three things make up most of the work:
- A request is one call to one address.
- A sequence is a list of requests that run in order and can pass values to each other.
- An environment holds the addresses, credentials and headers that change between test and production, so the same requests can be pointed at either.
What a request returns can be written into a data set in the platform, or kept as values that later requests in the same sequence can use.
Use API Composer when
- Service Automation Suite needs to read data from an external REST API.
- stored records need to be sent to another system.
- several calls must run in a fixed order.
- values from one call are needed by later calls.
- API configuration must move between Service Automation Suite systems.
Documentation map
| Topic | What you will find |
|---|---|
| the restricted guide | Create and run your first request. |
| the restricted guide | Collections, folders, requests, and sequences. |
| the restricted guide | Reuse hosts, headers, variables, and credentials. |
| the restricted guide | Test calls and prepare records to send. |
| the restricted guide | Batching, paging, errors, retries, and polling. |
| the restricted guide | Store response rows or pass values between requests. |
| the restricted guide | Run and publish configured work. |
| the restricted guide | Move portable configuration between systems. |
| the restricted guide | Outcome-based procedures. |
| the restricted guide | Errors, limits, and FAQ. |
In this section
Move forward with Service Automation Suite.
Questions about your use case? Let us help.