Web API overview

A Web API is an API (Application Programming Interface) for either a web server or a web browser. In iCore Integration Suite, a Web API is a program written in C# based on the ASP.NET Core framework.

Working with Web APIs in iCore Integration Suite involves the following steps:

• Security considerations – Decide how you are going to handle security related to Web APIs.
• Create a Web API – Web APIs are created and edited in the Web API Editor. The API is saved as a Web API definition entity.
• Execute and host a Web API – The Web API definition is executed with the Workflow activity Execute Web API definition. The Web API is hosted with a Kestrel web service (see https://docs.microsoft.com/en-us/aspnet/core/fundamentals/servers/kestrel), and at iCore runtime in a Kestrel server process.

Software dependencies

An iCore Web API definition is bundled with the following software:

• ASP.NET Core (2.0.1 as of iCIS v4.1 Update 3)
• NSwag v11.12.9

See Also

Entities

Web API

Workflow activities

Execute Web API definition

Tools

Web API editor

Web APIs

Security guidelines
Creating a Web API
Executing and hosting a Web API
Using Entity filters in Web APIs