Zespy.EzPlan.Integration.Client 1.2.0

ezPlan integration client

Typed partner calls authenticated with a Management-issued product API key (X-Api-Key). Targets .NET Framework 4.6.2, .NET 8 and .NET 10; .NET Framework 4.7.2 consumers use the 4.6.2 asset.

Supply a dedicated HttpClient configured without redirects, cookies, automatic retries or default Authorization headers. The caller owns its lifetime. Set BaseAddress, the permitted InstanceKey and ApiKey on PlanManagerConnectionClientOptions. The server validates the key's product access and instance binding; source DTOs describe the authenticated partner's staff and organisation, and never grant authority themselves.

Commands are sent once. On an uncertain delivery retain the exact request and idempotency key, read current status and retry the same command only where appropriate. This SDK does not generate replacement keys or retry POSTs. The default total request timeout is 15 seconds (maximum 60); caller cancellation applies to transport and bounded response reading. Responses are limited to 512 KiB, reject duplicate JSON properties and invalid success identities. Unknown additive response fields remain compatible.

GetInvitationStatusAsync returns null only for a status HTTP 404 carrying connection-invitation-not-found. Other non-success responses throw PlanManagerConnectionClientException with StatusCode and a safe stable Code; response bodies and credentials are excluded from exception messages. Internal Zespy provider handover and acceptance contracts are intentionally excluded from these packages.

Uncoded HTTP 400 is connection-request-invalid; 401/403 is connection_not_permitted; an unmapped 404 is connection_response_invalid. Transport failures and the SDK's deadline use a null status with connection_owner_unavailable, without exposing transport details. Explicit caller cancellation remains cancellation.

Both Integration packages follow the existing public NuGet lane and validate a clean net462;net8.0;net10.0 consumer before publication. Actual public publication is restricted by the shared template to stable ezPlan v* tags. Creating/pushing such a release tag promotes Production and requires Micha's approval; no publication is performed by local validation.

The options-only constructor owns a dedicated HTTP transport with automatic redirects and cookies disabled; dispose the SDK client when finished. The injected HttpClient overload is for controlled hosts and tests: the caller must disable automatic redirects and remains responsible for its lifetime. The SDK rejects any 3xx response it receives, but cannot undo a redirect already followed by an injected transport. Only a status 404 carrying connection-invitation-not-found means absence.