API Versioning
Learn about and access an API version.
Table of Contents
- How does API versioning work?
- How do I view an API version?
- How do I access an API version?
How does API versioning work?
An API is composed of one or more versions accessible on the Version menu on the API Resource Title Bar.
Note: Only API Administrators and designated team members are authorized to create an API version.
- Documentation—The My APIs > Documents page includes release notes that covers new functionality and updates for each API version, and a complete set of API documentation for each API version.
- API Access—When requesting access to an API using the API Access function, you must first select the API version from the Version menu on the API Details page, then click Access to launch the API Access Wizard.
- Delete Version—If an API Administrator deletes an API version that currently is part of an approved API Access Request, API Access will be cancelled. The App Developer must then issue a new API Access Request.
- New Version— If the API Administrator has configured an alert to notify developers when a new API version is available, upgrade notifications will be issued and posted in the Dashboard, App Talkbox, and API Talkbox.
Back to top
How do I view an API version?
The APIs Resource Title Bar includes a Version drop-down menu that allows you to view API versions. After selecting an API version you can view the API documentation and configuration details. See What are the components of the APIs section?
Back to top