Packaging API Guide

Overview

You can preprocess and package your content using our HTTP-based APIs instead of building a separate server using the CLI Preprocessor or library.

sequenceDiagram
    participant A as Service site
    participant B as PallyCon cloud
    A ->> B: Encoded MP4
    B -->> B: Watermark preprocessing
    opt Apply Multi-DRM
    B -->> B: Content encryption
    end
    B ->> A: Packaged result
    Note right of B: DASH / HLS content<br>(two set with 0, 1 marked)

The packaging storage and job management APIs use the following common specifications:

PallyCon HTTP API Specification

The HTTP API requests used by the PallyCon service follow the specifications below.

Please find the API request sample code in Sample Download page.

Request

Request Data JSON Format

{
    "data":"{aes256 cbc encryption of 'API data' for each API, and base64 encoding}",
    "timestamp":"{yyyy-mm-ddThh:mm:ssZ}",
    "hash":"{sha256 hash of 'message format' in base64 string}"
}

Request Data Specification

AES256 Encryption

Aes256 encryption / decryption processing is performed as below using the site key value issued when joining PallyCon service. (Check PallyCon Console site)

• mode : CBC
• AES key : 32 byte (Site key issued from PallyCon Console site)
• AES IV : fixed 16 byte (0123456789abcdef)
• padding : pkcs7

SHA256 message Format

The input value of the SHA256 hash is a combination of the following strings.

[site access key] + [site_id] + [json.data] + [json.timestamp]

• site access key: It is the access key value that is issued when creating PallyConsole Cloud service site. It can be checked on the PallyCon Console page.
• The resulting value of the sha256 hash function must be input to the base64 function as a binary data, not as a string.

Storage Registration API

An API that registers storage used for watermark preprocessing and packaging job. Before you can register a packaging job, you must register the storage that will be used for the job through this API.

Request

• Use PallyCon Cloud HTTP API specification
• URL : https://api.pallycon.com/api/v2/storage/[SITE_ID]
• Method: POST
• Content type: application/json;charset=UTF-8

The ‘SITE_ID’ part of the URL should be your site ID issued from PallyCon Console site.

API Data JSON Format

{
	"storage_name" : "{storage name}",
	"type" : "{storage type}",
	"id": "{access id}",
	"password": "{access password}",
	"aws_bucket": "{bucket name}",
	"description" : "{description}",
	"region": "{region}"
}

API Data Specification

Response

Response Data JSON Format

{
	"storage_id": "{storage id}",
	"error_code": "{error code}",
	"error_message": "{error message}"
}

Response Data Specification

Storage Update API

An API that modifies storage information used for watermark preprocessing and packaging operations.

Request

• Use PallyCon Cloud HTTP API specification
• Url: https://api.pallycon.com/api/v2/storage/[SITE_ID]
• Method: PUT
• Content type: application/json;charset=UTF-8

API Data JSON Format

{
	"storage_id" : "{storage id}",
	"storage_name" : "{storage name}",
	"description": "{description}"
}

API Data Specification

Response

Response Data JSON Format

{
	"storage_id": "{storage id}",
	"error_code": "{error code}",
	"error_message": "{error message}"
}

Response Data Specification

Storage List API

An API to get a list of registered storage.

Request

• Use PallyCon Cloud HTTP API specification
• Url : https://api.pallycon.com/api/v2/storage/[SITE_ID]
• Method : GET
• Content type : application/json;charset=UTF-8

API Data JSON Format

{
	"search_keyword": "{search keyword}",
	"search_keyword_type": "{storageId / storageName}",
	"storage_type": "S3",
	"region": "{region}",
	"from": "{YYYY-MM-DD'T'hh:mm:ss'Z'}",
	"to": "{YYYY-MM-DD'T'hh:mm:ss'Z'}",
	"page_unit": "{Number value}",
	"page_index": "{Number value}",
	"time_zone": "{hh:mm}"
}

API Data Specification

Response

Response Data JSON Format

{
	"error_code": "{error code}",
	"error_message": "{error message}",
	"total_count": "total count",
	"time_zone": "{hh:mm}",
	"data": [{
		"storage_id" : "{storage id}",
		"storage_name" : "{storage name}",
		"type" : "{storage type}",
		"id": "{access id}",
		"password": "{access password}",
		"aws_bucket": "{bucket name}",
		"description" : "{description}",
		"region": "{region}",
		"reg_date": "{YYYY-MM-DD'T'hh:mm:ss'Z'}"
	}]
}

Response Data Specification

Packaging Job Registration API

This API registers new watermark packaging job. Before you can register a packaging job, you must first register a storage and upload the original MP4 file to that storage.

Request

• Url: https://api.pallycon.com/api/v2/pack/[SITE_ID]
• Method: POST
• Content type: application/json;charset=UTF-8

Limitations for trial account

1. Trial does not support adaptive streaming content packaging.
2. The original video to be packaged is only supported in the mp4 format.
3. A trial account can perform only one packaging job.

API Data JSON Format

{
	"job_name": "{job name}",
	"storage":{
		"input":{
			"storage_id": "{storage id}",
			"contents_path":[ input contents path ]
		},
		"output":{
			"storage_id": "{storage id}",
			"path": "{output path}"
		}
	},
	"content_id": "{content id}",
	"streaming_format": [dash, hls],
	"protect_type": [ drm, watermark ],
	"subtitles":[
		{
		"path": "{subtitle path}",
		"language": "{language}"
		}
	],
    "dash_option":{
        "min_buffer_time": {Number value},
        "enable_average_bandwidth_mpd": {true|false}
    },
    "drm_option": {
        "multi_key": {true|false},
        "skip_audio_encryption": {true|false},
        "max_sd_height": {Number value},
        "max_hd_height": {Number value},
        "max_uhd1_height": {Number value},
        "clear_lead": {Number value},
        "generate_tracktype_manifests": {true|false}
    }	
}

API Data Specification

storage.input

storage.output

subtitles

dash_option

drm_option

Response

Response Data JSON Format

{
	"error_code": {error code},
	"error_message": {error message},
	"job_id": {job id}
}

Response Data Specification

Packaging Job List API

An API used to retrieve a list of packaging jobs from PallyCon packaging server.

Request

• Url : https://api.pallycon.com/api/v2/pack/{siteId}
• Method : GET
• Content type : application/json;charset=UTF-8

API Data JSON Format

{
	"search_keyword": "{search keyword}",
	"search_keyword_type": "{cid, jobId, jobname}",
	"search_type": "{watermark, drm}",
	"search_status": "{ready, success, failed, complete, working, process}",
	"search_condition": "{dash, hls}",
	"from": "{YYYY-MM-DD'T'hh:mm:ss'Z'}",
	"to": "{YYYY-MM-DD'T'hh:mm:ss'Z'}",
	"page_unit": "{Number value}",
	"page_index": "{Number value}",
	"time_zone": "{hh:mm}"
}

API Data Specification

Response

Response Data JSON Format

{
	"error_code": "{error code}",
	"error_message": "{error message}",
	"total_count": "{count}",
	"time_zone": "{hh:mm}",
	"data": [ {
		"job_id": "{job id}",
		"job_name": "{job name}",
		"start_date": "{start date({YYYY-MM-DD'T'hh:mm:ss'Z')}",
		"update_date": "{update date({YYYY-MM-DD'T'hh:mm:ss'Z')}",
		"reg_date": "{registered date({YYYY-MM-DD'T'hh:mm:ss'Z')}",
		"watermark": "{watermark use}",
		"drm": "{true/false}",
		"dash": "{true/false}",
		"hls": "{true/false}",
		"content_id": "{content id}",
		"status": "{status}",
		"storage":{
			"input":{
				"storage_id": "{storage id}",
				"contents_path":[ input contents path ]
			},
			"output":{
				"storage_id": "{storage id}",
				"path": "{output path}"
			}
		},
		"subtitles":[ {
			"path": "{subtitle path}",
			"language": "{language}"
		} ]
	} ]
}

Content(track) List API

An API to inquire the list of source tracks included in a specific packaging job, the packaging progress by track, and various other information.

Request

• Url : https://api.pallycon.com/api/v2/pack/{siteId}/contents
• Method : GET
• Content type : application/json;charset=UTF-8

API Data JSON Format

{
	"job_id": "{Packaging job ID}"
}

API Data Specification

Response

Response Data JSON Format

{
    "error_code": "{error code}",
    "error_message": "{error message}",
    "total_count": "total count",
    "data": [{
      "job_id": "{job Id}",
      "seq": "{content seq}",
      "input_path":"{input file path}",
      "status": "{status code}",
      "duration": "{duration}",
      "content_size": "{content size}",
      "width": "{width}",
      "height": "{height}",
      "fps": "{fps}",
      "bitrate": "{bitrate}",
      "update_date":"{update date}",
    }]
}

Packaging Result Callback Integration

If you set a callback URL for packaging job result on PallyCon Console site, the web page will receive the below request when a job is finished or if there is an error.

Request data JSON

The below JSON data will be sent to the callback URL in POST method without any encryption.

{
    "job_id": <job_id>,
    "error_code": <error_code>,
    "error_message": <error_message>,
    "input_contents_path": [<input_contents_path>...],
    "output_path": <output_path>
}