https://community.appian.com/success/w/tutorial/3472/extending-appianen-USTelligent Community 12https://community.appian.com/success/w/tutorial/3472/extending-appianTue, 23 Apr 2024 13:39:33 GMTd3a83456-d57b-489c-a84c-4e8267bb592a:0bdca772-c829-4f66-a1f2-dc92e62f3fb2Appian Max Teamhttps://community.appian.com/success/w/tutorial/3472/extending-appian#commentsCurrent Revision posted to Tutorial by Appian Max Team on 4/23/2024 1:39:33 PM<br /> <div style="margin:8px 16% 8px 8%;"> <h2 id="how_to_ccreate_connected_systems" class="guide-headers">How do You Create a Connected System with Integration Objects?</h2> <p>How do you call an integration in Appian? In this video, learn how you should use outbound integrations and inbound web APIs to connect Appian with external systems.</p> <div style="margin-top:22px;width:90%;"></div> <div style="margin-top:22px;width:90%;"><a href="https://www.youtube.com/watch?v=l0bF0n-CCtk?feature=shared">www.youtube.com/watch</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Integrations are used for connecting and transfering data between Appian and an external system.</li> <li>Outbound integrations are for when Appian initiates the call to an external system, and are build by creating a connected system object and an integration object.</li> <li>Inbound Web APIs are for when an external system needs to call Appian, and are built by creating a Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_get_web_api" class="guide-headers">How to Create a GET Web API</h2> <p>Learn how to create a GET web API for an Appian application using the hello, world template.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/qymPQcPEcQo?si=fjJJp_eusAlMEQZb?feature=shared">youtu.be/qymPQcPEcQo</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>GET Web APIs can be created from a template or from scratch.</li> <li>When using a template, the http method will already be set and the a!httpResponse function, which is used to determine what happens when the API is called, will already be pre-populated.</li> <li>Passing values into the Web API is done through query parameters, headers, in the body of the request, or a combination of these.</li> <li>Web APIs work when an external system sends a request to the endpoint we created in the Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_post_web_api" class="guide-headers">How to Create a POST Web API</h2> <p>Learn how to create a POST web API for an Appian application. This POST web API uses a write to datastore entity smart service that allows external systems to write new customer data.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/kqQPoV8j3_Q?si=9QTyfGyV3xh9K-oj?feature=shared">youtu.be/kqQPoV8j3_Q</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>POST Web APIs allow external systems to create new data in Appian.</li> <li>The Write to Data Store template will convert the data in the body of the request to an Appian value, and then utilize the a!writeToDataStoreEntity smart service to write to a table within Appian.</li> <li>The template also provides functionality for on success and on error.</li> <li>To add test data, create a json blob inside the body with both the field name and the value inside of quotation marks.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_authenticate_web_api" class="guide-headers">How to Authenticate Web API</h2> <p>Learn how to authenticate a Web API in Appian. Here are three ways that Appian web APIs can authenticate external systems: basic authentication, API key authentication, and OAuth 2.0 Client Credentials Grants.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/t1g5hKXZ6gA?si=VdNG7Mg5mZ6mXfRy?feature=shared">youtu.be/t1g5hKXZ6gA</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Appian APIs can only be called by an external system that has been authenticated, either through an authenticated Appian user or a service account.</li> <li>For basic authentication, a user name that has permission to call the Web API and a password must be provided in the request.</li> <li>API Keys provide a more secure, performant, and long-lasting way to authenticate, using service accounts that have access to the Web API.</li> <li>Oauth 2.0 Client Credentials Grant is an industry standard protocol for authentication, which also uses service accounts to gain access.</li> </ul> </div> </div> </div> </div><div style="clear:both;"></div> <div style="font-size: 90%;">Tags: integrations, application design, Architecture</div> https://community.appian.com/success/w/tutorial/3472/extending-appian/revision/2Tue, 13 Feb 2024 18:45:07 GMTd3a83456-d57b-489c-a84c-4e8267bb592a:0bdca772-c829-4f66-a1f2-dc92e62f3fb2joel.larinhttps://community.appian.com/success/w/tutorial/3472/extending-appian#commentsRevision 2 posted to Tutorial by joel.larin on 2/13/2024 6:45:07 PM<br /> <div style="margin:8px 16% 8px 8%;"> <h2 id="how_to_ccreate_connected_systems" class="guide-headers">How do You Create a Connected System with Integration Objects?</h2> <p>How do you call an integration in Appian? In this video, learn how you should use outbound integrations and inbound web APIs to connect Appian with external systems.</p> <div style="margin-top:22px;width:90%;"></div> <div style="margin-top:22px;width:90%;"><a href="https://www.youtube.com/watch?v=l0bF0n-CCtk?feature=shared">www.youtube.com/watch</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Integrations are used for connecting and transfering data between Appian and an external system.</li> <li>Outbound integrations are for when Appian initiates the call to an external system, and are build by creating a connected system object and an integration object.</li> <li>Inbound Web APIs are for when an external system needs to call Appian, and are built by creating a Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_get_web_api" class="guide-headers">How to Create a GET Web API</h2> <p>Learn how to create a GET web API for an Appian application using the hello, world template.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/qymPQcPEcQo?si=fjJJp_eusAlMEQZb?feature=shared">youtu.be/qymPQcPEcQo</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>GET Web APIs can be created from a template or from scratch.</li> <li>When using a template, the http method will already be set and the a!httpResponse function, which is used to determine what happens when the API is called, will already be pre-populated.</li> <li>Passing values into the Web API is done through query parameters, headers, in the body of the request, or a combination of these.</li> <li>Web APIs work when an external system sends a request to the endpoint we created in the Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_post_web_api" class="guide-headers">How to Create a POST Web API</h2> <p>Learn how to create a POST web API for an Appian application. This POST web API uses a write to datastore entity smart service that allows external systems to write new customer data.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/kqQPoV8j3_Q?si=9QTyfGyV3xh9K-oj?feature=shared">youtu.be/kqQPoV8j3_Q</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>POST Web APIs allow external systems to create new data in Appian.</li> <li>The Write to Data Store template will convert the data in the body of the request to an Appian value, and then utilize the a!writeToDataStoreEntity smart service to write to a table within Appian.</li> <li>The template also provides functionality for on success and on error.</li> <li>To add test data, create a json blob inside the body with both the field name and the value inside of quotation marks.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_authenticate_web_api" class="guide-headers">How to Authenticate Web API</h2> <p>Learn how to authenticate a Web API in Appian. Here are three ways that Appian web APIs can authenticate external systems: basic authentication, API key authentication, and OAuth 2.0 Client Credentials Grants.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/t1g5hKXZ6gA?si=VdNG7Mg5mZ6mXfRy?feature=shared">youtu.be/t1g5hKXZ6gA</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Appian APIs can only be called by an external system that has been authenticated, either through an authenticated Appian user or a service account.</li> <li>For basic authentication, a user name that has permission to call the Web API and a password must be provided in the request.</li> <li>API Keys provide a more secure, performant, and long-lasting way to authenticate, using service accounts that have access to the Web API.</li> <li>Oauth 2.0 Client Credentials Grant is an industry standard protocol for authentication, which also uses service accounts to gain access.</li> </ul> </div> </div> </div> </div><div style="clear:both;"></div> <div style="font-size: 90%;">Tags: integrations, application design, Architecture</div> https://community.appian.com/success/w/tutorial/3472/extending-appian/revision/1Tue, 13 Feb 2024 18:30:22 GMTd3a83456-d57b-489c-a84c-4e8267bb592a:0bdca772-c829-4f66-a1f2-dc92e62f3fb2joel.larinhttps://community.appian.com/success/w/tutorial/3472/extending-appian#commentsRevision 1 posted to Tutorial by joel.larin on 2/13/2024 6:30:22 PM<br /> <div style="margin:8px 16% 8px 8%;"> <h2 id="how_to_ccreate_connected_systems" class="guide-headers">How do You Create a Connected System with Integration Objects?</h2> <p>How do you call an integration in Appian? In this video, learn how you should use outbound integrations and inbound web APIs to connect Appian with external systems.</p> <div style="margin-top:22px;width:90%;"></div> <div style="margin-top:22px;width:90%;"><a href="https://www.youtube.com/watch?v=l0bF0n-CCtk?feature=shared">www.youtube.com/watch</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Integrations are used for connecting and transfering data between Appian and an external system.</li> <li>Outbound integrations are for when Appian initiates the call to an external system, and are build by creating a connected system object and an integration object.</li> <li>Inbound Web APIs are for when an external system needs to call Appian, and are built by creating a Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_get_web_api" class="guide-headers">How to Create a GET Web API</h2> <p>Learn how to create a GET web API for an Appian application using the hello, world template.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/qymPQcPEcQo?si=fjJJp_eusAlMEQZb?feature=shared">youtu.be/qymPQcPEcQo</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>GET Web APIs can be created from a template or from scratch.</li> <li>When using a template, the http method will already be set and the a!httpResponse function, which is used to determine what happens when the API is called, will already be pre-populated.</li> <li>Passing values into the Web API is done through query parameters, headers, in the body of the request, or a combination of these.</li> <li>Web APIs work when an external system sends a request to the endpoint we created in the Web API object.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_create_a_post_web_api" class="guide-headers">How to Create a POST Web API</h2> <p>Learn how to create a POST web API for an Appian application. This POST web API uses a write to datastore entity smart service that allows external systems to write new customer data.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/kqQPoV8j3_Q?si=9QTyfGyV3xh9K-oj?feature=shared">youtu.be/kqQPoV8j3_Q</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>POST Web APIs allow external systems to create new data in Appian.</li> <li>The Write to Data Store template will convert the data in the body of the request to an Appian value, and then utilize the a!writeToDataStoreEntity smart service to write to a table within Appian.</li> <li>The template also provides functionality for on success and on error.</li> <li>To add test data, create a json blob inside the body with both the field name and the value inside of quotation marks.</li> </ul> <div style="margin-top:64px;"> <h2 id="how_to_authenticate_web_api" class="guide-headers">How to Authenticate Web API</h2> <p>Learn how to authenticate a Web API in Appian. Here are three ways that Appian web APIs can authenticate external systems: basic authentication, API key authentication, and OAuth 2.0 Client Credentials Grants.</p> <div style="margin-top:22px;width:90%;"><a href="https://youtu.be/t1g5hKXZ6gA?si=VdNG7Mg5mZ6mXfRy?feature=shared">youtu.be/t1g5hKXZ6gA</a></div> <h3>Video highlights</h3> <ul style="font-size:115%;"> <li>Appian APIs can only be called by an external system that has been authenticated, either through an authenticated Appian user or a service account.</li> <li>For basic authentication, a user name that has permission to call the Web API and a password must be provided in the request.</li> <li>API Keys provide a more secure, performant, and long-lasting way to authenticate, using service accounts that have access to the Web API.</li> <li>Oauth 2.0 Client Credentials Grant is an industry standard protocol for authentication, which also uses service accounts to gain access.</li> </ul> </div> </div> </div> </div><div style="clear:both;"></div>