Previewing a New API Version

 

ON THIS PAGE      Show

 

 

 

 

To ensure continuous Media API content delivery, a new Media API version is made available to you for preview and testing of the new features before it becomes the default API version.

Important Dates

The new API version release process involves three important dates:

  • Preview Start Date. The new version (for example, 2.2) is available for both testing and production use. We strongly recommend that you test and begin taking measures to upgrade to the new version.

  • Default Switch Date. The new version becomes the default API version. You can access the previous version (for example, 2.1) by specifying it in the API request URL.

  • Retirement Date. The previous version is no longer available for access. Make sure to complete your integration with the new version by this date.

Accessing the New API Version

Based on your integration options, you can access the new API version in one of the following ways:

If you are making API requests:

Switch to "v{new_version_number}" in the request URL; for example, "v2.2": https://api.ap.org/media/v2.2/content/feed

 

Make sure to supply the API key in the x-api-key request header.


  Note

 

  1. If your testing determines that the changes do not cause any issues for your ingestion, and your current API request URL refers to the default version  (https://api.ap.org/media/v/content/feed), there is no need to take any action - you will automatically be upgraded to the new API version on the Default Switch Date.

  2. If you need more time to adjust to the changes, switch to “v{previous_version_number}” (for example, "v2.1") in the API request URL prior to the Default Switch Date to continue using that version: https://api.ap.org/media/v2.1/content/feed. Remember that you MUST make any necessary upgrades and resume referring to the default version (https://api.ap.org/media/v/content/feed) prior to the Retirement Date to prevent disruption to your Media API delivery. All calls to the previous version ("v2.1") will be rejected starting on the Retirement Date.

 

 

 

If you are using the agent and dashboard: 

Select "Preview" from the Access Mode list on the Content Ingest Agent page:

For more information, see What is Access mode?

 

  Important

 

If you are running older versions of the agent, we strongly urge you to automatically upgrade to the latest version to avoid potential issues and take full advantage of the new features and improved performance in the latest releases of the agent, dashboard and AP Media API.