Business support

Media portal API support

Media portal is the CenturyLink customer portal for CDN services. Through Media portal, you can configure user accounts, group your services for reporting purposes, view historical and real-time usage, and order and configure new services.

CenturyLink web-service APIs (application programming interfaces) allow developers to build software that interacts directly with the CenturyLink CDN portal data without requiring use of the browser-based user interface. While the browser-based portal is ideal for many users, some situations require access to data feeds so that customers may incorporate CenturyLink CDN data directly into their own tools and systems. Media portal APIs are designed to meet this need.

Our aim, over time, is to provide an API equivalent for each functional area that is available in Media portal itself.

API style

The authentication, authorization and API style is common across the full product set. (For example, Caching APIs and Streaming APIs use a similar style, without requiring a different set of credentials to access them.)

The API interface style used is representational state transfer (REST). The hierarchical organization of the CDN service tree makes the REST style a good fit for the CDN APIs. The service tree hierarchy for the purposes of calling the APIs is: Access Group > SCID > Network Identifier.

The API architecture is stateless.
 

  • Every HTTPS API request must include all of the information required for the server to fulfill that request.

  • Each request is constructed to be complete, unless information is provided back to the server from the client within the new request.

  • Some API functions may be submissions for a process which will not be completed for several minutes, such as cache invalidation requests. For an invalidation request, the server might immediately accept the request and return a transaction ID. The client may then poll the server with the transaction ID for an update on the state of the request.

Default host

The default host for all API calls is:
https://ws.level3.com

Version number

The APIs described in this section belong to Media portal API version 1.5 by default. As APIs in version 2.0 are created, their descriptions will be added, and version numbers will be noted.

Getting started with Media portal APIs

Media portal APIs follow the REST (representational state transfer) style. RESTful web services leverage the design principles of HTTP 1.1.

The common HTTP methods are used to denote the nature of the action to be taken—the “verb”. (For example, the GET method is used only to retrieve data, never to delete it.) The URI contains the information that defines what the call acts upon—the “nouns”. URIs are constructed logically, reflecting natural hierarchies of resources and are designed to be easily human-readable.

APIs are called by making an HTTP request with a selected method to the required URI. Responses include XML data in the request response body providing the requested data or result of the operation. Each request must be signed in order to be authenticated by the process.

Follow these steps to prepare to use Media portal APIs:
  1. Decide which API(s) you need to call.

    Read the API Descriptions section to determined which Media portal APIs you will need to call. Write code to form the request and handle the response.
  1. Acquire an API key.

    An API key consists of a numeric ID and a secret. Keys can be created on the Media portal CDN API Security Keys or Vyvx API Security Keys pages.
Learn more about API keys
  1. Locate the Access Group ID. (Required for some API calls.)

    Because the access group name is editable, Media portal assigns an access group ID that does not change. The access group ID is required as part of the scope for some API requests, and the API key is used to locate this ID.
Locating the access group ID
  1. Determine which SCID or Network Identifier values to include in your URI syntax. (Required for some API calls.)

    If you are developing an API that includes a specific SCID or Network Identifier as part of the scope, you can determine these values using the Services Hierarchy API.
  1. Implement code to append a signature to the requests you send.

    Each request must be “signed” in order to ensure that the request can be authenticated.
Learn more about API signature and authentication