ErgOpsDocs

Developer API overview

ErgOps Embedded is the governed API surface of ErgOps. It lets B2B products, ERP/TMS/WMS integrations and customer applications calculate traceable emissions without manually reproducing factor, methodology, tenant or usage logic.

What is ErgOps Embedded?#

Each credential belongs to one approved organization and one environment. A request resolves an existing customer account, creates a canonical transport activity, applies a governed factor and returns a stable customer-safe result. Successful Live calculations are metered against the effective B2B contract period; Test calculations remain isolated and non-billable.

Core guarantees#

  • organization and customer isolation;
  • deterministic calculation with factor lineage;
  • durable idempotency;
  • explicit Test and Live separation;
  • locally auditable usage;
  • signed, retryable webhooks;
  • versioned /v1 public contract.

API version policy#

ErgOps does not silently introduce breaking changes inside v1. A breaking contract change requires a new version or a governed migration. Deprecations are communicated before removal; no fixed contractual notice duration is implied by this technical policy.