Authentication

GET /v5/creatives HTTP/1.1
Host: api.uplynk.com
Authorization: Bearer <jwt>

import base64, time
from os import getenv

import jwt  # PyJWT
import requests
from dotenv import load_dotenv

load_dotenv()
PRIVATE_KEY = base64.b64decode(getenv("PRIVATE_B64"))

def call_v5_api(path, scopes, method="GET", body=None):
    """scopes must include one of the endpoint's required scopes, e.g. :write for POST/PATCH/DELETE."""
    now = int(time.time())
    token = jwt.encode(
        {"aud": "uplynk:api", "sub": getenv("SUB"), "scp": scopes, "iat": now, "exp": now + 300},
        key=PRIVATE_KEY,
        algorithm="ES256",
        headers={"kid": getenv("KID")},
    )
    response = requests.request(
        method,
        f"https://api.uplynk.com/v5{path}",
        headers={"Authorization": f"Bearer {token}"},
        json=body,
    )
    response.raise_for_status()
    return response.json()

creatives = call_v5_api("/creatives", ["video.services.creatives:read"])
created = call_v5_api("/creatives", ["video.services.creatives:write"], "POST", {"title": "Spring promo"})

// Create message object
const msg = {
  _owner: "your_user_id",
  _timestamp: Math.floor(Date.now() / 1000)
};

// For v2 APIs, include all parameters here
if (isV2Api) {
  Object.assign(msg, requestSpecificParams);
}

// Compress and encode
const msgString = JSON.stringify(msg);
const compressed = zlib.deflate(msgString, { level: 9 });
const encodedMsg = base64Encode(compressed);

// Create HMAC-SHA256
const sig = hmacSha256(encodedMsg, "your_api_key");

const url = `https://services.uplynk.com/api2/resource/action?msg=${encodedMsg}&sig=${sig}`;
// Make GET or POST request to this URL (no body)

const url = `https://services.uplynk.com/api/v4/resource/id?msg=${encodedMsg}&sig=${sig}`;
const headers = { "Content-Type": "application/json" };
const body = JSON.stringify(requestSpecificParams);
// Make request with appropriate method and JSON body

import base64, hashlib, hmac, json, time, urllib.parse, zlib
import requests

def call_v2_api(uri, **params):
    """Call v2 API with all parameters in the msg."""
    user_id = "your_user_id"
    api_key = "your_api_key"
    
    # Include all params in the message
    msg = {
        "_owner": user_id,
        "_timestamp": int(time.time()),
        **params
    }
    
    # Encode and sign
    msg_json = json.dumps(msg)
    msg_compressed = zlib.compress(msg_json.encode(), level=9)
    msg_b64 = base64.b64encode(msg_compressed).decode()
    sig = hmac.new(api_key.encode(), msg_b64.encode(), hashlib.sha256).hexdigest()
    
    # Make request (all in URL, no body)
    url = f"https://services.uplynk.com{uri}"
    payload = dict(msg=msg_b64, sig=sig)
    response = requests.post(url, data=payload)
    return response.json()

def call_v4_api(uri, method, body=None):
    """Call v4 API with auth in msg and data in the request body."""
    user_id = "your_user_id"
    api_key = "your_api_key"
    
    # Only auth params in message
    msg = {
        "_owner": user_id,
        "_timestamp": int(time.time())
    }
    
    # Encode and sign
    msg_json = json.dumps(msg)
    msg_compressed = zlib.compress(msg_json.encode(), level=9)
    msg_b64 = base64.b64encode(msg_compressed).decode()
    sig = hmac.new(api_key.encode(), msg_b64.encode(), hashlib.sha256).hexdigest()
    
    # Make request (auth in URL, data in body)
    url = f"https://services.uplynk.com{uri}"
    params = dict(msg=msg_b64, sig=sig)
    headers = {"Content-Type": "application/json"} if body else None
    
    response = requests.request(
        method=method,
        url=url,
        params=params,
        json=body,  # Will be sent as JSON in body
        headers=headers
    )
    return response.json()

# Example v2 API call
assets = call_v2_api("/api2/asset/list", limit=10)

# Example v4 API call
audience = call_v4_api(
    "/api/v4/audiences/da3114eedfdf499fb7fb38a21614ec40",
    "PATCH",
    {"country_codes": ["GB", "ZA"]}
)

const crypto = require("crypto");
const zlib = require("zlib");
const fetch = require("node-fetch");

async function callUplynkApi(uri, method, params, isV2) {
    const USER_ID = "your_user_id";
    const API_KEY = "your_api_key";
    
    // Create message object (auth params only for v4)
    const msg = { 
        _owner: USER_ID, 
        _timestamp: Math.floor(Date.now() / 1000)
    };
    
    // For v2, include all params in message
    if (isV2) {
        Object.assign(msg, params);
    }
    
    // Encode and sign
    const msgString = JSON.stringify(msg);
    const compressed = zlib.deflateSync(msgString, { level: 9 });
    const base64Msg = compressed.toString("base64");
    const sig = crypto.createHmac("sha256", API_KEY).update(base64Msg).digest("hex");
    
    // Create URL with auth params
    const baseUrl = "https://services.uplynk.com";
    const url = new URL(baseUrl + uri);
    url.searchParams.append("msg", base64Msg);
    url.searchParams.append("sig", sig);
    
    // Set up request options
    const options = {
        method: method,
        headers: {}
    };
    
    // For v4, add body if not GET/DELETE
    if (!isV2 && params && method !== "GET" && method !== "DELETE") {
        options.body = JSON.stringify(params);
        options.headers["Content-Type"] = "application/json";
    }
    
    // Make request
    const response = await fetch(url.toString(), options);
    return await response.json();
}

// Example v2 API call
callUplynkApi("/api2/asset/list", "GET", { limit: 10 }, true)
    .then(data => console.log("V2 result:", data));

// Example v4 API call
callUplynkApi(
    "/api/v4/audiences/da3114eedfdf499fb7fb38a21614ec40",
    "PATCH", 
    { country_codes: ["GB", "ZA"] }, 
    false
).then(data => console.log("V4 result:", data));

{
  "msg": ["Unrecognized parameter: allowed_play."],
  "error": 1
}

{
  "msg": ["track_type is not valid: Values allowed are ['SD', 'HD', 'AUDIO', 'UHD1', 'UHD2', 'ALL']"],
  "error": 1
}

{
  "msg": ["DRM Config not found."],
  "error": 1
}