Skip to main content

Migration Guides

Who this is for: existing integrators. When to use it: when a breaking change is announced, or when moving between stages. What happens next: a clear, step-by-step path with no surprises.

Documentation redesign — no migration required​

The developer portal was redesigned for clarity (navigation, terminology, onboarding, design). No API contracts changed. Endpoints, routes, request and response fields, enums, payloads, authentication methods, SDK signatures, environment variables, and webhook payloads are all unchanged. Existing integrations continue to work with no code changes.

What changed (documentation only):

  • Demand vs Supply are now clearly separated and consistently named.
  • Added Getting Started, lifecycle guides, and error/status references.
  • Restructured navigation and the homepage.

How we handle future breaking changes​

When a breaking change is unavoidable, we publish a guide here with:

  1. What's changing and why.
  2. Who is affected (Demand, Supply, or both).
  3. Before / after request and response examples.
  4. A timeline with the deprecation date and dual-running window.
  5. A rollback path.

Moving from sandbox to production​

This is a configuration change, not a code migration:

  1. Swap the base URL to the production host — see Environments.
  2. Swap to production credentials.
  3. Smoke-test on low volume before scaling.

Migration Notes​

Demand API reference is now generated from the spec​

The Demand API reference pages are now generated by the OpenAPI documentation pipeline (same as Supply) and grouped into Projects, Qualifications, Quotas, Group Security, Reconciliation, and Reference Data. This is a documentation-only change: no endpoint paths, request/response schemas, hosts, enums, payloads, or authentication methods were modified. Existing integrations are unaffected.

⚠️ Demand production-host inconsistency (action for the API/backend team)​

There is a documentation/spec mismatch that must be reconciled at the source — it is intentionally not "fixed" here because doing so would change runtime base-URL behavior:

  • The Demand OpenAPI spec (vendorIntegrationApi.yaml) declares a single server: https://zampliabackend-staging.azurewebsites.net (staging only).
  • The Setup & Base URLs page lists a production host of https://zamplia.zamplia.com.

Until the backend team confirms the canonical production host, treat the Environments page as provisional for Demand production and validate against staging. No base URL has been added to or removed from the spec as part of this documentation work.

Questions about a migration? Contact Support.