Menu

Lumen help

Implement our APIs

Introduction

Welcome! We are glad you value of the essential API building blocks as much as we do. We use them to support our self-service portal and are happy to support your autonomy to dream up use cases we may not have thought of. Here you will learn how to quickly onboard, discover, and consume CDN API endpoints. We are evolving our offers and think you will like the direction we are taking with our newest version 3.0 endpoints.

API Style

The authentication, authorization and API style is common across the full product set. Your API keys (credentials) can be used for one or all of our endpoints.
 

The API architecture is stateless and restful.
 

API requests are authorized by RFC 2104-compliant HMAC.

Getting and managing your API Credentials (Keys)

For existing customers who have access to the Media Portal, your Media Portal administrator (role=domain admin) can create and manage up to 5 API keys, or they can elevate your permission to do it yourself. There is no need to request credentials from Lumen. If you are not a Lumen customer you’ll need to first activate your account.

API keys, like users, are tied to a specific scope. Below are the main components.

 

 

Key ID

This is one part of the authorization header of API requests.

Key Secret

When combined with other elements represents the API signature and other component of the authorization header. (More on constructing an API signature or obtain postman pre-request script-link)

Access Group

The scope of the key representing a collection of caching services it may operate on.

Role

Determines the operations allowed. Each endpoint will specify if a specific role is required. In some cases write operations may be blocked a key is associated with a lower level role, such as reporting.

 

Versions, Deprecation, and Out of Support

Our versions are apparent in th base URI and any considerations needed to use one or the other are noted in the specific content describing them. Whenever me make changes that could impact your code, we will create a new version in order not to disrupt your implementations.

Getting started with Media Portal APIs

Follow these steps to prepare to use Media portal APIs:

  1. Obtain your API credentials with the proper scope and permissions.
     

  2. Decide which API(s) you wish to use and which identifiers are required in the base URI.
     

  3. Prepare to send your first API call.
     

    1. Construct a signature to accompany your first API call. (Learn more and access code samples), Or, download this pre-request script to use with Postman instead (More on constructing an API signature or obtain postman pre-request script-link).
       

    2. Make a call to a supportive endpoint as needed.
       

  4. Send your first API call!
     

    1. Using the host and base URI indicated on the API specification you are following, you’ve now got all you need.

Configuration Management V3 endpoint catalog

The complete documentation of Configuration Management V3 API endpoints can be found here. Please check this page regularly as the documentation is updated regularly.