Overview
Customers of PallyCon service can check various data such as content packaging and license issuance on PallyCon Web Console . But there are also cases that API-based data access is needed. So we provide PallyCon Service API
to allow the customers integrate our server-side data with their system.
This document describes how to use the PallCon Service API V2
which was released in December 2021.
API Basics
PallyCon Service API
uses JSON Web Token(JWT) for secure transmission of information.
You can create and test the token using an online JWT tool or a server-side programming language.
Service API JWT Specification
The token should be signed using an account-specific secret key with HMAC SHA256(HS256) algorithm. Please create a ticket on Helpdesk to get your Service API Key and the account seq value used in the token payload.
JWT Structure
As shown on the above image, an encoded JWT token has the following format:
base64UrlEncode(header) + "." + base64UrlEncode(payload) + "." + HS256 signature value
Payload Specification
The token uses json payload data as below example:
{
"sub" : "PallyConAPI",
"aud" : "INKA",
"iss" : "PallyCon",
"account_id" : "Your PallyCon account ID",
"account_seq": "Your PallyCon account SEQ",
"exp": 1583191411
}
Key
Required
Value
sub
Y
Fixed value as PallyConAPI
aud
Y
Fixed value as INKA
iss
Y
Fixed value as PallyCon
account_id
Y
Your account ID of PallyCon service
account_seq
Y
Your PallyCon account’s SEQ
(can be requested via Helpdesk ticket)
exp
N
Expiration date of the token (type: date number)
SEQ
is a key value used to index key data in PallyCon service API.
Common Response Specification
When calling the PallyCon Service API, you’ll get one of the HTTP status codes listed below.
HTTP Status Code
Description
401
JWT Token specification is incorrect or the user information cannot be found
403
Do not have permission for the called API
200
HTTP communication success
When the HTTP status code is 200
(HTTP communication success), you’ll get the below response data in JSON format.
Key
Type
Value
error_code
String
0000: Success / other numbers: failure
error_message
String
Shows the error message on failed request
data
JSON
Result of the successful API request
Account Management API
These APIs are for managing PallyCon service account and sites.
A site
in PallyCon service means a service site of our customer where PallyCon solution is applied. A PallyCon account has one site
by default, and additional sites can be added to an account if needed. (e.g. a reseller account with multiple customers)
A site has a unique ID as four alphanumeric characters.
Get Site List
This API retrieves the list of sites under the PallyCon account.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed API code as UC011004100
Response.data
Key
Type
Description
site_id
String
Unique ID of the site (four alphanumeric characters)
service_name
String
Name of the service site
Request Additional Service Site
This API requests additional service site for the account. (in case of multiple service sites in an account)
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010310200
service_name
String
Y
Name of the additional service site
Response.data
Key
Type
Description
seq
Int
Sequence number of the request
Get Status of Additional Site Request
This API returns the status of request for additional service site.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010310100
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
req_status
String
N
Status of the request
search_type
String
N
Type of the search (account_id, site_id)
search_keyword
String
N
Keyword for the search (used when search_type is set)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
Response.data
Key
Type
Description
seq
Int
Sequence number of the request
account_id
String
ID of the service account
site_id
String
ID of the service site
service_name
String
Name of the service site
status
String
Status of the additional site request
update_time
String
Datetime of the status update
reg_time
String
Datetime of the request registration
Get Sub-member List
This API returns the list of sub-members in an account.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010700200
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
Response.data
Key
Type
Description
group_name
String
The sub-member’s group name
group_seq
Int
Sequence number of the group (refer to the below table)
member_seq
Int
Sequence number of the sub-member
member_email
String
Email address of the sub-member
status_code
String
Status code (MT001: active member, MT002: inactive)
reg_date
String
Date of the sub-member registration (YYYY-MM-DD)
Group SEQ List
Group seq
Description
1000
BIZ Group. Can access service usage history, integration information and payment related pages.
1001
TS Group. Can access service usage history, integration information and SDK download pages.
1014
Clients Group. Can access service usage history pages only.
Create Sub-member
This API creates a sub-member in an account.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010700200
member_email
String
Y
Email address of the sub-member
group_seq
Int
N
Sequence number of a member group to set
Response.data
Key
Type
Description
member_seq
Int
Sequence number of the sub-member
Reset Password for Sub-member
This API resets password of a sub-member.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010700200
member_seq
Int
Y
Sequence number of the sub-member
Response
This API returns the default response data.
This API updates a sub-member’s information such as group and status.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value as UA010700200
member_seq
Int
Y
Sequence number of the sub-member
member_status
String
N
Status code to apply (MT001: active, MT002: inactive)
group_seq
Int
N
Sequence number of a member group to set
Response
This API returns the default response data.
DRM Service API
These APIs are for retrieving DRM-related data.
Get DRM License List
This API retrieves the list of each DRM license that was responded in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
API code value (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_status
String
N
License issuance status (success or fail)
search_condition
String
N
Search category (cid, drm_type, user_id, device_id, device_model)
search_keyword
String
N
The keyword for category search (valid when search_condition is set)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
curl -H 'authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJQYWxseUNvbkFQSSIsImF1ZCI6IklOS0EiLCJpc3MiOiJQYWxseUNvbiIsImFkbWluIjp0cnVlLCJ1c2VySWQiOiJ0ZXN0dXNlciJ9.p7VJmRryoaSVU2qn9PDuoDRIFxphw0N2786bR6zhELQ' 'https://service.pallycon.com/api/v2/drm/license?api_code=UA003001100&site_id=DEMO&from=2020-03-01&to=2020-03-02&search_status=success&search_condition=cid&search_keyword=test'
Response.data (Array)
Key
Type
Description
cid
String
Unique content ID
status
String
License issuance status (success, fail)
error_code
String
Error code (0000 for successful license issuance)
drm_type
String
Type of DRM (PlayReady, Widevine, FairPlay, NCG)
user_id
String
Unique ID of end user
device_id
String
Unique ID of client device
device_model
String
Device model name
license_type
String
Type of DRM license integration (token, gateway)
platform_name
String
Client platform name
reg_time
String
Datetime of the license request
{
"_links":{
"self":{
"href":"http://service.pallycon.com/api/v2/drm/license"
}
},
"error_code":"0000",
"data":[{
"cid":"configtest",
"status":"success",
"error_code":"0000",
"drm_type":"FairPlay",
"user_id":"uuu",
"device_id":"13406080a61bef63aaa1d99a32f51e31c804e659",
"device_model":"iOS-device",
"license_type":"gateway",
"platform_name":"iOS",
"reg_time":"20200302235959"
},
{
"cid":"configtest",
"status":"success",
"error_code":"0000",
"drm_type":"FairPlay",
"user_id":"uuu",
"device_id":"13406080a61bef63aaa1d99a32f51e31c804e659",
"device_model":"iOS-device",
"license_type":"gateway",
"platform_name":"iOS",
"reg_time":"20200302235956"
}],
"count":2
}
}
Get DRM User List
This API retrieves the list of end user ID that acquired license in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_keyword
String
N
The user ID to search
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
curl -H 'authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJQYWxseUNvbkFQSSIsImF1ZCI6IklOS0EiLCJpc3MiOiJQYWxseUNvbiIsImFkbWluIjp0cnVlLCJ1c2VySWQiOiJ0ZXN0dXNlciJ9.p7VJmRryoaSVU2qn9PDuoDRIFxphw0N2786bR6zhELQ' 'https://service.pallycon.com/api/v2/drm/user?api_code=UA003001100&site_id=DEMO&from=2020-03-01&to=2020-03-02
Response.data (Array)
Key
Type
Description
user_id
String
Unique ID of end user
license_cnt
Int
Number of licenses requested by the user
device_cnt
Int
Number of client devices used by the user
success
Int
Number of successful license issuance
fail
Int
Number of failed license issuance
{
"_links":{
"self":{
"href":"http://service.pallycon.com/api/v2/drm/user"
}
},
"error_code":"0000",
"data":[{
"user_id":"ta5uwrsw",
"license_cnt":1,
"device_cnt":1,
"success":1,
"fail":0
},
{
"user_id":"uuu",
"license_cnt":1729,
"device_cnt":1,
"success":1729,
"fail":0
},
{
"user_id":"5xhsdd36",
"license_cnt":1,
"device_cnt":1,
"success":1,
"fail":0
}],
"count":3
}
}
Get DRM Device List
This API retrieves the list of client devices that acquired license in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_keyword
String
N
The device ID to search
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
curl -H 'authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJQYWxseUNvbkFQSSIsImF1ZCI6IklOS0EiLCJpc3MiOiJQYWxseUNvbiIsImFkbWluIjp0cnVlLCJ1c2VySWQiOiJ0ZXN0dXNlciJ9.p7VJmRryoaSVU2qn9PDuoDRIFxphw0N2786bR6zhELQ' 'https://service.pallycon.com/api/v2/drm/device?api_code=UA003001100&site_id=DEMO&from=2020-03-01&to=2020-03-02
Response.data (Array)
Key
Type
Description
device_id
String
Unique ID of client device
device_model
String
Client device model
license_cnt
Int
Number of licenses requested from the device
success
Int
Number of successful license issuance
fail
Int
Number of failed license issuance
{
"_links":{
"self":{
"href":"http://service.pallycon.com/api/v2/drm/device"
}
},
"error_code":"0000",
"data":[{
"device_id":"ea2e698d95b28441422f4997d6ffd5450a",
"device_model":"ChromeCDM-Windows-2",
"license_cnt":1732,
"success":1732,
"fail":0
},
{
"device_id":"13406080a61bef63aaa1d99a32f51e31c804e659",
"device_model":"iOS-device",
"license_cnt":1729,
"success":1729,
"fail":0
},
{
"device_id":"ab3dd736cd46607abbd81ec942e07a620a",
"device_model":"ChromeCDM-Mac-2",
"license_cnt":1,
"success":1,
"fail":0
},
{
"device_id":"d838f619-69e0-4e3a-9b48-5a1b52ce287a",
"device_model":"playready-device",
"license_cnt":1728,
"success":1728,
"fail":0
}],
"count":4
}
Get DRM CID License List
This API retrieves the number of licenses issued for each CID(content ID) in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_status
String
N
License issuance status (success or fail)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
curl -H 'authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJQYWxseUNvbkFQSSIsImF1ZCI6IklOS0EiLCJpc3MiOiJQYWxseUNvbiIsImFkbWluIjp0cnVlLCJ1c2VySWQiOiJ0ZXN0dXNlciJ9.p7VJmRryoaSVU2qn9PDuoDRIFxphw0N2786bR6zhELQ' 'https://service.pallycon.com/api/v2/drm/cid-drmLicense?api_code=UA003001100&site_id=DEMO&from=2020-03-01&to=2020-03-02
Response.data (Array)
Key
Type
Description
cid
String
Unique ID of content
license_cnt
Int
Number of licenses issued for the content
{
"_links":{
"self":{
"href":"http://service.pallycon.com/api/v2/drm/cid-drmLicense"
}
},
"error_code":"0000",
"data":[
{
"cid":"bigbuckbunny",
"license_cnt":1733
},
{
"cid":"configtest",
"license_cnt":1729
}],
"count":2
}
Get DRM CID User List
This API retrieves the number of end users who acquired license for a CID(content ID) in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
cid
String
Y
Unique ID of the content
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_status
String
N
License issuance status (success or fail)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
curl -H 'authorization:Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiJQYWxseUNvbkFQSSIsImF1ZCI6IklOS0EiLCJpc3MiOiJQYWxseUNvbiIsImFkbWluIjp0cnVlLCJ1c2VySWQiOiJ0ZXN0dXNlciJ9.p7VJmRryoaSVU2qn9PDuoDRIFxphw0N2786bR6zhELQ' 'https://service.pallycon.com/api/v2/drm/cid-user?api_code=UA003001100&site_id=DEMO&cid=bigbuckbunny&from=2020-03-01&to=2020-03-02
Response.data (Array)
Key
Type
Description
cid
String
Unique ID of content
user_id
String
Unique ID of end user
license_cnt
Int
Number of licenses issued for the content
{
"_links":{
"self":{
"href":"http://service.pallycon.com/api/v2/drm/cid-user"
}
},
"error_code":"0000",
"data":[{
"cid":"bigbuckbunny",
"user_id":"test-user",
"license_cnt":1728
},
{
"cid":"bigbuckbunny",
"user_id":"rd1z7c08",
"license_cnt":1
}],
"count":2
}
Get DRM Packaging History
This API retrieves the DRM packaging records in a certain period.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA003001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_condition
String
N
Search category (cid, drm_type, user_id, device_id, device_model)
search_keyword
String
N
The keyword for category search (valid when search_condition is set)
last_created_time_cid
String
N
Creation time of the lastly retrieved CID item (for pagination)
last_update_time
String
N
Update time of the lastly retrieved item (for pagination)
When the last_created_time_cid
and last_update_time
are set, the response will contain the data that is later than the settings.
Response.data (Array)
Key
Type
Description
site_id
String
Site ID
value shown on PallyCon Console
cid
String
Unique ID of the content
track
String
content track type (default: HD)
created_time
String
Datetime of the first packaging for the content
update_time
String
Datetime of re-packaging for the content
Get DRM Integration Info
This API retrieves the information for DRM integration.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
site_id
Path Variable
Y
The Site ID
value shown on PallyCon Console
api_code
String
Y
Fixed code of the API (UA003004100)
Response.data
Key
Type
Description
site_id
String
Site ID
value shown on PallyCon Console
site_key
String
Encryption key for the service site integration (32 bytes base64 string)
access_key
String
Additional encryption key for the integration
license_callback_url
String
Webpage URL for callback type license integration (deprecated)
package_callback_url
String
Webpage URL for callback type packager integration (deprecated)
kms_token
String
Security token for KMS integration such as CPIX and SPEKE API
token_duration
Int
Duration of a license token validity (in seconds)
iv
String
Site-specific initial vector (IV) value for DRM encryption
Update DRM Integration Info
This API updates the information for DRM integration.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
site_id
Path Variable
Y
The Site ID
value shown on PallyCon Console
api_code
String
Y
Fixed code of the API (UA003004100)
license_callback_url
String
N
Webpage URL for callback type license integration (deprecated)
package_callback_url
String
N
Webpage URL for callback type packager integration (deprecated)
token_duration
Int
N
Duration of a license token validity (in seconds)
Response
This API returns the default response data.
Register FairPlay Certificate
This API registers the FPS certificate to PallyCon service.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
site_id
Path Variable
Y
The Site ID
value shown on PallyCon Console
api_code
String
Y
Fixed code of the API (UA003004200)
ask
String
Y
Application secret key generated on Apple developer site
key_pw
String
Y
Private key password (max 32 bytes)
cert
blob
Y
FPS certificate file (.der or .cer)
private_key
blob
Y
Private key file (.pem)
Response
This API returns the default response data.
Forensic Watermarking Service API
Get Watermark Packaging List
This API returns the list of watermark packaging jobs.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
security
String
N
Security type (drm, watermark)
search_status
String
N
Packaging status (ready, success, failed, complete, working, process, stop)
streaming_format
String
N
Streaming format (dash, hls)
search_keyword
String
N
The keyword for the search_keyword_type
search_keyword_type
String
N
Category for keyword search (cid, job_id, job_name)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
Response.data (Array)
Key
Type
Description
job_id
String
ID of the packaging job
job_name
String
Name of the packaging job
status
String
Status of the packaging job
region
String
AWS region code (refer to the below table)
start_time
String
Packaging job start time
update_time
String
Last status update time
reg_time
String
Packaging job registration time
watermark
Boolean
Whether watermark is applied
drm
Boolean
Whether DRM is applied
dash
Boolean
Whether DASH packaging is applied
hls
Boolean
Whether HLS packaging is applied
site_id
String
The Site ID
value shown on PallyCon Console
content_id
String
Unique ID of the content
storage
JSON
Input/output storage information
subtitles
JSON Array
Subtitle input data
drm_option
JSON
DRM related options
dash_option
JSON
DASH related options
Region Code
Code
Description
RG004
Oregon (us-west-2)
RG006
Singapore (ap_southeast-1)
RG010
Tokyo (ap-northeast-1)
RG011
Seoul (ap-northeast-2)
RG013
Frankfurt (eu-central-1)
Register Watermark Packaging Job
This API registers a new watermark packaging job.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001200)
site_id
String
Y
The Site ID
value shown on PallyCon Console
job_name
String
Y
Name of the packaging job
input_id
String
Y
ID of the input storage registered on PallyCon
input_contents_path
JSON Array
Y
Filepath of the source contents. Multiple items can be set for adaptive streaming.
output_id
String
Y
ID of the output storage registered on PallyCon
output_path
String
Y
Path on the output storage for storing the packaged result
content_id
String
Y
Unique ID of the content (max 200 bytes)
streaming_format
Array
Y
Output streaming format (dash, hls)
protect_type
Array
Y
Content protection types (drm, watermarking). watermarking
type is mandatory while drm
is optional
subtitles
Array
N
Subtitle information
Response.data
Key
Type
Description
data
Int
ID of the registered packaging job
Register Storage for Packaging
This API registers a input/output storage for the packaging service.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001200)
site_id
String
Y
The Site ID
value shown on PallyCon Console
storage_name
String
Y
Name of the storage
type
String
Y
Storage type (supports S3 only as of now)
id
String
Y
Storage access ID (AWS access key id)
password
String
Y
Storage access password (AWS secret access key)
aws_bucket
String
Y
S3 bucket name
description
String
N
Description of the storage
region
String
Y
AWS region code (refer to the packaging job list API)
Response.data
Key
Type
Description
data
Int
ID of the registered storage
Get Watermark Storage List
This API returns the list of storages registered for the packaging service.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_keyword
String
N
The keyword for the search_keyword_type
search_keyword_type
String
N
Category for keyword search (storage_id, storage_name)
region
String
Y
AWS region code (refer to the packaging job list API)
storage_type
String
Y
Type of the storage (supports S3 only as of now)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
Response.data (Array)
Key
Type
Description
storage_id
String
ID of the registered storage
storage_name
String
Name of the storage
type
String
Storage type (supports S3 only as of now)
id
String
Storage access ID (AWS access key id)
password
String
Storage access password (AWS secret access key)
aws_bucket
String
S3 bucket name
description
String
Description of the storage
region
String
AWS region code (refer to the packaging job list API)
reg_time
String
Datetime of the storage registration (YYYY-MM-DD’T’hh:mm:ss’Z)
Get Watermark Session List
This API returns the list of watermark sessions created via Session Manager API.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
search_keyword
String
N
The keyword for the search_keyword_type
search_keyword_type
String
N
Category for keyword search (watermark, session_key)
page_unit
Int
N
Number of search result (default:25, max: 1000)
last_watermark_token
String
N
Lastly retrieved key (for pagination)
last_created_time
String
N
Creation time of the lastly retrieved key (for pagination)
When the last_watermark_token
and last_created_time
are set, the response will contain the data that is later than the settings.
Response.data (Array)
Key
Type
Description
watermark_token
String
Watermark token for the session
forensic_mark
String
The watermark data embedded in the stream
created_time
String
Creation time of the session
Response.lastKey
Key
Type
Description
watermark_token
String
Lastly retrieved watermark token
created_time
String
Creation time of lastly retrieved item
Get Watermark Detection List
This API returns the list of watermark detection results.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
from
String
N
Start date of the search (YYYY-MM-DD)
to
String
N
End date of the search (YYYY-MM-DD)
time_zone
String
N
Timezone setting for the search (+HH:mm)
service_code
String
N
Detection service code (default: PD002) - PD002: forensic watermarking - PD005: Anti-piracy
search_keyword
String
N
The keyword for the search_keyword_type
search_keyword_type
String
N
Category for keyword search (title, detection_id) default: title
status
String
N
Detection status code to search (refer to the below table)
page_unit
Int
N
Number of search result (default:25, max: 1000)
page_index
Int
N
Index of result page when the results are more than page_unit
Response.data (Array)
Key
Type
Description
detection_id
Number
ID of the detection job
site_id
String
The Site ID
value shown on PallyCon Console
title
String
Title of the detection target content
status
String
Detection status code (refer to the below table)
file_id
Number
Takedown ID for Anti-Piracy service. Upload file ID for Forensic Watermarking service.
service_code
String
Service code for the detection (PD002: forensic watermarking, PD005: anti-piracy)
fwm_token
String
Watermark token detected from the video
fwm_data
String
Detected watermark information (detection result)
update_time
String
Update time of the detection job
reg_time
String
Registration time of the detection job
Detection Status Code
Status Code
Description
FD001
Ready to start detection
FD002
Downloading the video file
FD003
Watermark detection in progress
FD004
Detection process completed
FD005
Detection process canceled
FD006
An error occurred during the detection
FD007
Failed to detect watermark from the video
Get Watermark Detection Details
This API returns the detailed information of a watermark detection job.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
api_code
String
Y
Fixed code of the API (UA005001100)
site_id
String
Y
The Site ID
value shown on PallyCon Console
detection_id
String
N
Detection ID retrieved by the listing API
Response.data
Key
Type
Description
detection_id
Number
ID of the detection job
site_id
String
The Site ID
value shown on PallyCon Console
title
String
Title of the detection target content
status
String
Detection status code (refer to the table)
file_path
String
Filepath of the detection target video
region
String
AWS service region code (refer to the table)
service_code
String
Service code for the detection (PD002: forensic watermarking, PD005: anti-piracy)
fwm_token
String
Watermark token detected from the video
fwm_data
String
Detected watermark information (detection result)
error_code
String
Watermark detection error code
description
String
Description about the error code
update_time
String
Update time of the detection job
reg_time
String
Registration time of the detection job
Get Watermark Integration Info
This API returns the information required for the watermark integration.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
site_id
Path Variable
Y
The Site ID
value shown on PallyCon Console
api_code
String
Y
Fixed code of the API (UA005003200)
Response.data
Key
Type
Description
site_id
String
The Site ID
value shown on PallyCon Console
site_key
String
Encryption key for the service site integration (32 bytes base64 string)
access_key
String
Additional encryption key for the integration
watermark_callback_url
String
Webpage URL for packaging result callback
watermark_region
String
AWS service region code for watermark packaging service
iv
String
Site-specific initial value for the packaging
Update Watermark Integration Info
This API updates the information for watermark integration.
Request
Parameter
Type
Required
Description
Authorization
Header
Y
Encoded JWT data
site_id
Path Variable
Y
The Site ID
value shown on PallyCon Console
api_code
String
Y
Fixed code of the API (UA005003200)
watermark_callback_url
String
Webpage URL for packaging result callback
region
String
AWS service region code for watermark packaging service
Response
This API returns the default response data.