SDKs and Tools

Choose tools that fit your workflow

LCE exposes RESTful JSON APIs through OpenAPI definitions. Use the interactive API Reference for discovery, import a definition into an API client or generate a project-owned client for your preferred language.

Recommended toolchain

Explore

Lidia API Reference

Find operations by business domain, inspect schemas and run authorized requests with “Try It”.

Test

cURL or an API client

Use cURL for reproducible examples, or import OpenAPI into tools such as Postman for collections and environments.

Generate

OpenAPI Generator

Create typed clients, models or server stubs from the API definition and keep generation reproducible in CI.

Validate

OpenAPI linting

Run a specification validator before importing, publishing or generating code from a definition.

Import an OpenAPI definition

Download or export the curated LCE definition for the domains your integration uses.
Import the JSON or YAML file into your API client.
Create environment variables for the base URL, JWT and tenant context.
Review example values before sending any write operation.
Regenerate or re-import when the pinned definition version changes.

For large definitions, prefer a curated public surface or domain-based definitions over importing every internal operation into one collection.

Generate a client

Example with OpenAPI Generator:

# TypeScript Fetch client
openapi-generator-cli generate \
  -i ./lce-openapi.json \
  -g typescript-fetch \
  -o ./generated/lce-client

# C# client
openapi-generator-cli generate \
  -i ./lce-openapi.json \
  -g csharp \
  -o ./generated/lce-client-csharp

Pin the generator version and the input definition in source control. Place custom authentication, retries and domain helpers outside generated files so regeneration does not overwrite application logic.

Client responsibilities

Concern	Recommendation
Base URL	Read it from environment configuration; never hard-code a shared hostname.
Authentication	Add the JWT Bearer header centrally and prevent secrets from reaching logs.
Timeouts	Set explicit connect and request timeouts appropriate to the business flow.
Retries	Retry only transient failures and only when the operation is safe or idempotency is guaranteed.
Errors	Preserve HTTP status, service message, correlation data and validation details.
Versioning	Pin the definition and generated package version; review API changes before upgrading.

Choose by task

Learning an API: start in the Lidia API Reference.
Reproducing a request: use cURL with environment variables.
Collaborating on collections: import OpenAPI into your team’s API client.
Building a typed integration: generate a client and wrap it with domain-specific code.
Publishing changes: lint the definition and run contract tests in CI.