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.
Target host versions
Web API definitions support different target host environments which is specified with the property Target host version.
We recommend that new Web API definitions always use the latest available version, to ensure that they have access to the latest features and security patches.
Existing definitions that use a legacy version can be upgraded to a new version with the Web API Editor. Note that an upgrade only updates references to ASP.NET Core and related bundled references, it does not modify any of the code in the Web API, which means that you likely need to modify code manually after the upgrade.
Software dependencies
An iCore Web API definition is bundled with the software shown in the table below. The target host version of the Web API determines which versions of the packages are available.
| Package | Version in v1 | Version in v2 |
|---|---|---|
| ASP.NET Core | 2.0.1 | 2.1 |
| NSwag | 11.12.9 | 13.17.0 |
See Also
Entities
Workflow activities
Tools
Web APIs
Security guidelines
Creating a Web API
Executing and hosting a Web API
Using Entity filters in Web APIs