API life cycle and deprecation strategy

To keep you up to date with the latest versions of APIs, Pismo must occasionally deprecate and further decommission older versions of APIs. When an endpoint or API is deprecated, Pismo strongly recommends updating to the newest versions before the decommission date. This allows for a smooth upgrade path to a newer release.

📘

For more information about APIs and upgrading, see API upgrades.

Terms and concepts

Term

Definition

API and Endpoint

Each product on the Pismo platform has a specific API, providing many services, known as endpoints. A Pismo API provides at least one endpoint. Endpoints represent the services that can be executed by an API product.

Every endpoint belongs to a specific API. For example:

  • Products: Accounts-API, Cards-API
  • Endpoints: Get account status, Create a card

Deprecation

A service has been ended (with or without a new version becoming available); support for the older API is limited to bug fixes only.

Sunsetting

Period of time from the deprecation date to formal decommissioning. The sunsetting period is usually six months. However, endpoints presenting vulnerability issues are decommissioned within three months.

Decommissioning

Older version is no longer available. Requests sent to this version fail beginning on the decommission date.

API life cycle

Version Status

Description

Documentation

Support

Pismo Bulletin

Active

Most up-to-date and recommended API version

Available on launch date.

Fully supported. Update with bug fixes and new features.

Notifications published two weeks prior to launch and again on launch date.

Deprecated

API is planned for removal and may or may not be superseded by a newer version.

New customers or new integrations by existing customers are denied access to deprecated APIs.

The version is marked as Deprecated on the day of deprecation.

Supported for six months from the deprecation date (bug fixes only).

Notification published on deprecation date.

Decommissioned

API is longer available. The version is decommissioned six months after in the deprecated status.

No documentation provided.

No support provided.

Notifications published 90, 60, 30, 15, and 7 days prior to decommissioning and again on the decommissioning date.

Communication schedule

ScheduleCommunication method
Deprecation datePismo Bulletin and Changelog
90, 60, 30, 15, and 7 days before decommissioningPismo Bulletin
Decommission datePismo Bulletin and Changelog

Did this page help you?