OptimaJet.Workflow.Api 23.0.0

OptimaJet.Workflow.Api

OptimaJet.Workflow.Api adds the Workflow Engine by Optimajet HTTP API to an ASP.NET Core application. It maps Workflow Designer and runtime endpoints, creates single-tenant or multi-tenant Workflow Runtime instances, and provides hooks for authorization and operation customization.

Workflow Engine NEO · HTTP API documentation · Get started · Release notes

Install

Install the core API package and one database integration. SQLite keeps a local evaluation self-contained:

dotnet add package OptimaJet.Workflow.Api
dotnet add package OptimaJet.Workflow.Api.Sqlite

The API targets .NET 8 and .NET 10 and requires an ASP.NET Core host. Direct dependencies include WorkflowEngine.NETCore-Core, WorkflowEngine.NETCore-Migrator, and Microsoft.AspNetCore.OpenApi. Create a web project with the .NET 10 SDK before adding these packages.

Minimal ASP.NET Core setup

using System.Text.Json.Serialization;
using OptimaJet.Workflow.Api;
using OptimaJet.Workflow.Api.Sqlite;
using OptimaJet.Workflow.Core.Runtime;

var builder = WebApplication.CreateBuilder(args);
builder.Services.AddControllers()
    .AddJsonOptions(options =>
        options.JsonSerializerOptions.Converters.Add(new JsonStringEnumConverter()));
builder.Services.AddWorkflowApiCore(options =>
{
    // options.LicenseKey = builder.Configuration["WorkflowApi:LicenseKey"];
});
builder.Services.AddWorkflowApiSqlite();
builder.Services.AddWorkflowRuntime(options =>
{
    options.ConnectionString = "Data Source=workflow.db";
    options.WorkflowRuntimeCreationOptions.ConfigureWorkflowRuntime = runtime => runtime.AsSingleServer();
});
// Development only: restrict the allowed origins in production.
builder.Services.AddCors(options =>
    options.AddDefaultPolicy(policy =>
        policy.AllowAnyOrigin().AllowAnyMethod().AllowAnyHeader()));

var app = builder.Build();
app.UseRouting();
app.UseCors();
app.MapWorkflowApi();
app.Run();

Use the SQL Server, PostgreSQL, MySQL, Oracle, or MongoDB integration package for a production database. SQLite is intended for evaluation.

API groups and licensing

Without a license key, the API exposes the Designer and health endpoints available with Workflow Engine Free. Data, Search, and RPC endpoint groups require a Workflow Engine NEO license or trial key. Configure authentication, authorization and CORS in the host application before exposing endpoints outside a trusted development environment.

Read the Workflow Engine EULA for the exact Workflow Engine Free grant, limits and attribution requirements.

Support

• Technical questions: support@optimajet.com
• Editions and evaluation: hello@optimajet.com

Source repository and issues