https://github.com/josev2046/nucleus-video-connector-prototype
A blueprint for an integration application to streamline video workflows between Nucleus and an Online Video Platform (OVP). This repository provides a two-step API retrieval method for video assets and their metadata, along with potential ingestion workflows.
https://github.com/josev2046/nucleus-video-connector-prototype
api blueprint connector dam integration mam nucleus ovp prototype workflow
Last synced: 5 months ago
JSON representation
A blueprint for an integration application to streamline video workflows between Nucleus and an Online Video Platform (OVP). This repository provides a two-step API retrieval method for video assets and their metadata, along with potential ingestion workflows.
- Host: GitHub
- URL: https://github.com/josev2046/nucleus-video-connector-prototype
- Owner: josev2046
- License: cc0-1.0
- Created: 2025-09-09T10:53:36.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-09-09T11:09:38.000Z (11 months ago)
- Last Synced: 2025-09-09T13:46:53.133Z (11 months ago)
- Topics: api, blueprint, connector, dam, integration, mam, nucleus, ovp, prototype, workflow
- Homepage: https://www.linkedin.com/pulse/streamlining-video-workflows-nucleus-connector-jose-velazquez-ma-dzm4e/
- Size: 10.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Nucleus Video Connector
[](https://doi.org/10.5281/zenodo.17085201)
A blueprint for an integration application to streamline video workflows between Nucleus and an Online Video Platform (OVP). This repository provides a two-step API retrieval method for video assets and their metadata, along with potential ingestion workflows.
### Introduction
Nucleus, developed by BAFTA, is a management system for awards, grants, and initiatives. This repository explores potential methods for connecting it to an OVP to automate the transfer of video files submitted through Nucleus. The proposed solution is based on a secure, two-step API retrieval process that fetches video files and their associated metadata.
---
## API Blueprint
Both API steps require authentication using a Nucleus Base URL, an Award ID, an API Key ID, and a generated signature with an expiration timestamp.
### 1. Retrieve Entry Metadata
The first step is to use the `/api/entries.php` endpoint to retrieve entry details. This API call provides vital information, including the `entryTitle` and, crucially, the `mediaItem` ID for the video. This unique ID links the entry to its corresponding video file within the Nucleus system.
```bash
curl -X POST "/api/entries.php" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "awardId=&entryId=&expires=&keyId=&signature="
```
The JSON response will contain a field, such as `data.Film file`, which holds the format `mediaItem:video:`. The `MEDIA_ITEM_ID` must be extracted for the subsequent step.
### 2. Get the MP4 Video URL
Once the `mediaItem` ID is obtained, use the `/api/mediaItem.php` endpoint. By specifying `type=download`, the direct URL to the transcoded MP4 video file can be retrieved. This call also necessitates a `viewerId` for logging and permissions.
```bash
curl -X POST "/api/mediaItem.php" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "mediaItemId=&type=download&viewerId=&expires=&keyId=&signature="
```
The response is a JSON object containing the video URL, for example: `https://d3cszrd24af8ic.cloudfront.net/path/to/your/video.mp4`.
---
## Ingestion Workflows
An integration application—a dedicated script, for example—can serve as the bridge between Nucleus and the OVP. Once the video URL is retrieved, two primary methods can be used to ingest the video into the OVP.
### Option A: Push via TUS Upload
The integration application downloads the video file stream from the Nucleus API and then uses a **resumable upload protocol**, such as TUS, to upload the video to the OVP's API. This method is reliable for large files and ensures the upload can be resumed if interrupted.
### Option B: Pull via Direct URL Ingestion
This method is simpler if the OVP supports it. The integration application requests the OVP to ingest the video directly from the Nucleus URL. The OVP's servers then pull the asset directly from the Nucleus API. This approach offloads the file transfer burden from the integration application.
I've previously documented both methods here:
* Velazquez, J. (2025). *TUS-resumable File Uploads (TUS)*. https://doi.org/10.5281/zenodo.15034989
* Velazquez, J. (2025). *Understanding video pull uploads by referencing an external URL*. https://doi.org/10.5281/zenodo.15286575
---
## Workflow Diagram
The workflow logic for this integration could follow these steps:
1. An admin or scheduler triggers a sync.
2. The integration application queries the Nucleus API for new or updated assets and their metadata.
3. For each identified asset, the application maps the Nucleus metadata to the required OVP format.
4. The application ingests the video using either a **Push (TUS)** or **Pull (Direct URL)** method.
5. After successful ingestion, the application uses further API calls to apply additional metadata or settings (e.g., privacy controls).
6. Once all assets have been processed, the integration reports its status.