Skip to content
EN FR

External REST integration

Documentation status: reference — see Maturity and evidence.

This page covers HTTP as an integration boundary. REST is an adapter around logiCells capabilities; it should not become the place where business logic is defined a second time.

Exposing logiCells

To expose a capability:

  1. declare the action in the model;
  2. stabilize its signature;
  3. mark it as published;
  4. configure the HTTP adapter and routes;
  5. apply authentication, authorization, and validation;
  6. generate or publish the OpenAPI contract when available.

Calling an external API

When a logiCells action depends on a third-party service:

  • isolate the HTTP client behind an integration adapter;
  • do not mix transport DTOs with business concepts;
  • define timeout and retry policy according to idempotency;
  • log a correlation identifier;
  • translate external errors into application-contract errors;
  • never place secrets in object identifiers or public metadata.

Synchronous versus long-running work

A short request may remain synchronous. A long-running, unreliable, or multi-step remote operation should usually start a process/job and return an acknowledgement instead of blocking the HTTP request.

Portability

The business model should remain usable if the integration later moves from REST to RPC, messaging, or another adapter.