Client APIs

Overview

This page explains the concept of using a connected system plug-in to provide server-side logic for a component plug-in.

What is a Client API?

Connected system plug-ins can expose client APIs that are called by component plug-ins to run logic on the server. Client APIs can access the configuration values stored in the connected system, including credentials. The component's client-side code (running in the user's browser) can pass in a request payload and then use values in the client API response to update what's shown to the user, call out to a third-party system, or take other action.

For more information, see Using Server-Side Logic in Component Plug-ins and Appian.Component.invokeClientAPI().

Examples

Text Detection Client API enabled Component Plug-in Example

Feedback