CARDINALCurrent status
No API retirement is planned. API v1 and the legacy unversioned aliases remain supported. No retirement notice is active.
We do not send Deprecation or Sunset date headers for these routes because no lifecycle dates have been announced.
The 90-day notice timeline
| Stage | What we publish | What clients should do |
|---|---|---|
| Notice published | Affected routes, replacement behavior, migration instructions and the earliest change date | Identify affected integrations and assign migration work |
| At least 90 days of notice | The existing behavior remains available during the announced migration window | Test the replacement and migrate before the announced date |
| Announced change date | The documented breaking change or retirement may take effect | Use the supported replacement and retain error handling |
Urgent security changes are the exception to the 90-day minimum. We will explain the affected behavior and required action in the notice.
Notices will appear on this page and in the OpenAPI description. No dates in this policy represent a scheduled change.
Deprecation and retirement are different
Deprecation advises clients to migrate. It does not, by itself, change an endpoint's behavior or stop responses.
Sunset identifies when an endpoint is expected to become unavailable. A deprecation notice can exist before a retirement date is chosen.
The versioning policy explains breaking changes and additive fields. A new optional response field does not require a new API version.
Read the lifecycle headers
| Header | Format | Interpretation |
|---|---|---|
Deprecation | A Structured Field Date: @ followed by Unix epoch seconds | The announced deprecation date, which may be in the future or past |
Sunset | An HTTP-date with weekday, day, month, year, time and GMT | The announced time when the resource is expected to become unavailable |
Link | A policy URL with rel="deprecation" | Documentation about the policy or an announced migration |
Deprecation uses the date syntax in RFC 9745. It is not a Boolean flag or an HTTP-date.
Sunset uses the HTTP-date format defined by RFC 8594. Parse each header using its own format.
When both dates are supplied, sunset must not precede deprecation. A policy link alone does not mean the endpoint has been deprecated.
These descriptions document future notice behavior. They are not examples of lifecycle date headers currently returned by Cardinal Silicon.
Prepare an integration for change
Use /api/v1 for new integrations. Inspect response headers and check this policy during maintenance.
Keep required-field checks and documented error handling. Ignore unrecognized optional response fields. Use the sandbox for inquiry validation tests.
If a notice is unclear, contact sales@cardinalsilicon.com with the affected route and your integration question.