Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Wowza advanced_token_authentication API

Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos. Use token authentication when distributing valuable or sensitive video content to audiences to ensure that only authorized users can access the content within the intended application. This allows for protection of intellectual property, compliance with regulations, and the ability to maintain control over content distribution. The token is embedded in the videos' embed URLs. Through the UI or Wowza Video API, you can choose one of the following options for token authentication of a video: - **NO_TOKEN** - Video files are accessible and can be downloaded and played by anyone at any time. This is the default. - **BASIC_TOKEN** - The platform automatically creates tokenized video URLs. This setting makes it hard for a viewer to extract the video URL and store it for usage in unintended applications over time since the embed URL, which has the token as part of the URL, will only be playable for 48 hours. The token auto renews after 48 hours when used in the intended application. - **ADVANCED_TOKEN** - You add the stream's JS embed code (Share Stream) and a token to your site to provide tokenization. The protections are similar to those for the Basic Token option except you customize the time limit, geographical limits, etc. during token creation. - **FOLLOW_DEFAULT:** - The token behavior is based on the **Default Playback Token Behavior** setting you selected for your Wowza account. See the Org Settings page in Wowza Video article for where to set this configuration. **Note:** You'll use the /videos endpoints to update and review the token authentication enums bulleted above.Before selecting to use the **ADVANCED_TOKEN**, you must, first, either: - Generate a key id via the Wowza Video API, then customize and generate a token via the Wowza Video 2.0 API to add to your site. You'll need the key id to create and sign the token. - Generate a key id and key via the Wowza Video 2.0 API, then customize and generate a standard common access token (CAT) through the means you usually use to create tokens to add to your site. You'll need the key id and key to create and sign the token. After you have your playback token, you add the video JS-embed and the playback token to your site if you're going to use the **ADVANCED_TOKEN** option. The JS-embed code automatically adds the player and related video to your site. See the section on how to embed the player and video".

Wowza advanced_token_authentication API is one of 48 APIs that Wowza publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include advanced_token_authentication. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, API documentation, a getting-started guide, and a changelog.

This API exposes 4 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.0.3, at version 2.0.0.

Requests are made against a single base URL, http://localhost:8087.

4 operations 3 paths 14 schemas 1 DELETE1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0.0
Base URL
https://api.video.wowza.com/api/v2.0
Authentication
HTTP Basic, HTTP Digest
Resource Areas
1

Authentication & Security 2

Wowza advanced_token_authentication API declares 2 security schemes for authenticating requests. It accepts HTTP basic authentication (basicAuth). It uses HTTP digest authentication (digestAuth). By default, every request must be authenticated.

  • basicAuth — HTTP Basic Authentication using Wowza Streaming Engine admin credentials
  • digestAuth — HTTP Digest Authentication

Paths & Operations 4

Across 3 paths, the API surfaces 4 operations — 1 DELETE, 1 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.

advanced_token_authentication 4

Operations related to using advanced token authentication, known in Wowza Video as a default playback token behavior option, with videos. Use token authentication when distributin…

POST
/playback_tokens/keys
Create a playback token key
createKey body → 200401403404410422
GET
/playback_tokens/keys
Fetch playback token keys
listPlaybackTokenKeys 3 params → 200401403404410
DELETE
/playback_tokens/keys/{id}
Delete a playback token key
deletePublicTokenKey 1 param → 204401403404410422
POST
/playback_tokens
Create a playback token
CreatePlaybackToken body → 200401403404410422

Schemas 14

The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are GenerateTokenRequest (12 properties), CreatePlaybackTokenKeyResponseModel (5 properties), PlaybackTokenKeyResponseModel (4 properties), CatnipClaim (2 properties). Each schema is shown below with its type and property counts.

Error403
object
1 property 1 required
Error401
object
1 property 1 required
PlaybackTokenKeyResponseModel
object
4 properties
GenerateTokenRequest
object
12 properties 2 required
CreatePlaybackTokenKeyResponseWrapper
object
Create playback token key for the Wowza Video REST API
1 property
GenerateTokenResponse
object
1 property
Error422
object
1 property 1 required
Error410
object
1 property 1 required
CreatePlaybackTokenKeyResponseModel
object
5 properties
CatnipClaim
object
2 properties
CreatePlaybackTokenKeyRequestModel
object
1 property 1 required
CreatePlaybackTokenKeyRequestWrapper
object
Create playback token key for the Wowza Video REST API
1 property
ListPlaybackTokenKeyResponseWrapper
object
2 properties
Error404
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

wowza-advanced-token-authentication-api-openapi.yml Raw ↑

Other APIs Wowza publishes across the network.

Wowza Streaming Engine Java API
Wowza Flowplayer
Wowza GoCoder SDK
Wowza Real-Time Streaming SDK
Wowza analytics_engagement API
Wowza analytics_ingest API
Wowza analytics_popularity API
Wowza analytics_viewers API
Wowza Applications API
Wowza assets API
Wowza categories API
Wowza clipping API