Change Log

High-level history of customer-facing changes to the ECGrid REST API. For the full API surface, see the interactive API docs.

v2.6 April 2026 Latest
  • New: Portal provisioning — create branded portal sites for networks and mailboxes with custom CSS, logo, and theme; mailbox portals inherit branding from the parent network portal.
  • OpenAPI 3.1 foundation — full schema descriptions, named request/response examples, tag-grouped endpoints, and improved Swagger UI navigation.
  • Consistent camelCase responses — every JSON property is now explicitly declared in camelCase across every endpoint (locked-in wire contract).
  • Plural endpoint groups — Swagger tags now match plural route prefixes (Users, Networks, Certificates, Mailboxes, …).
  • Hardened authentication — login endpoint now enforces a per-account lockout after repeated failures; JWT signing keys are sourced from Azure Key Vault.
  • Health probes — /health/live and /health/ready available for App Service / Kubernetes integrations.
v2.5 January 2026
  • New: Reports endpoints — monthly summaries, instant-stats snapshots, traffic stats, mailbox and interchange counts, and ad-hoc reporting across networks and mailboxes.
  • Per-API-key rate limits — every response now carries X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset headers; 429 Too Many Requests responses include a standard Retry-After.
  • Cancellation propagation — client disconnects now propagate to the backend, freeing server resources when a caller aborts mid-request.
v2.4 October 2025 Breaking
  • Versioned URL prefix — all endpoints now live under /v2/. This makes future, breaking changes safe to introduce alongside the existing surface (Stripe-style versioning).
  • Interchange list endpoints converted to POST — complex filter bodies moved out of the URL; existing GET-based list endpoints are now POST with a JSON body.
  • JSON-only content types — legacy XML response shapes have been removed; the API is JSON in, JSON out.
  • Marketing landing page — the API root (/) now serves a public overview page with quick-start code samples in cURL, C#, Java, Node.js, TypeScript, Python, PHP, and Go.
v2.3 June 2025
  • Mailbox endpoints — create, configure, list, suspend, activate, and update mailboxes within a network.
  • Network endpoints — full read/update/configuration surface for the top-level customer container.
v2.2 April 2025
  • Comm endpoints — configure AS2 connections (and the underlying transport options) directly via the API.
  • Carbon Copy routing — create routing rules that duplicate parcels or specific interchanges to additional EDI IDs during delivery.
  • Trading Partner / EDI ID realignment — consolidated and clarified TP and EDI ID endpoints under /ids.
v2.1 March 2025
  • Interchange endpoints — in-box, out-box, archive, and pending lookups, plus header inspection.
  • Parcel endpoints — upload, download, in-box and out-box archive lookups, status updates, and acknowledgment notes.
v2.0 February 2025
  • Certificate endpoints — add public/private certificates, create, renew, and terminate; supports SSH keys, SSL/TLS certs, and X.509.
  • Key endpoints — attach key/value metadata to mailboxes, partners, and EDI IDs for routing hints, custom headers, and per-partner overrides.
  • Status list lookup — one endpoint returns every status code and enumeration used across parcels, interchanges, callbacks, and other EDI flows.
  • Improved request validation — clear field-level error messages on bad input, with the offending field name surfaced in the response envelope.
v1.0 January 2025
  • Standard response envelope — every response now uses a consistent { httpStatus, success, message, traceId, data } shape; every error uses { httpStatus, success, message, detail, traceId, errorInfo? }.
  • Trace ID on every response — correlate API calls with internal logs when contacting support.