This page explains features, concepts, and considerations to use when building your connected system plug-in.
Branding
Good logos and descriptions will help users find and use your plug-in.
Add logos to your Connected System to show custom branding
Add a description that tells us how to use your system. Why would I use it? What is exciting about it?
For example, our Google Cloud Natural Language Connected System has the following description: Easily connect to Google Cloud Natural Language machine learning models. Extract structure and information from text, including both sentiment and key subjects such as people, places, and events. Integrations using this connected system will allow you to provide a text value and select which types of information to analyze.
When authentication is required to send and receive information, fields can be configured to securely store credentials. Appian supports the use of the following authentication types for API requests:
System username/password
Basic authentication
NTLM
Digest
Kerberos
SOAP request body
Prebuilt OAuth 2.0 (Authorization Code grant) - storage and retrieval of refresh and access tokens
Currently, you cannot build a plug-in that authenticates using:
Anything Involving Certificate-Based Signing
OAuth 2.0 (JWT Bearer Token)
Per use credentials for anything other than OAuth 2.0 (for example, per-user creds for Basic auth)
Secure storage of Short-lived token authentication
OAuth 2.0 (Client Credentials)
Workaround: You can configure your Connected System Template to request a token on each request. Be sure to review the policies and rate limits for the service you are connecting to.
If an HTTP proxy has been enabled by an Appian administrator, you can build the plug-in to use the provided configuration data when making HTTP requests.
Note: Connected system plug-ins won't support using the configured proxy unless you specifically develop them to do so. For an example, see Configuring HttpClient when a proxy is enabled.
SSL
Not supported. We do not currently provide trusted or client certificates.