Get Started with Media Shuttle API

Signiant Media Shuttle APIs allow you to automate and integrate Media Shuttle with other applications or workflows. The Media Shuttle Management API controls portal management, storage, and active transfer status. The System-To-Person API allows end-users to upload or download files and integrate accelerated Media Shuttle transfers using Signiant Manager+Agents, media asset managers, digital asset managers, or other applications.

Read the Media Shuttle API documentation on SwaggerHub

Authentication

To use the Media Shuttle API, you must have an API key, which is found in the IT Administration Console.

  1. Log in to your IT Administration Console.
  2. Click your user name to open the menu.
  3. Click Developer to view your API key.

    Account menu developer

  4. Click Copy to Clipboard to copy your API key to the clipboard.

To revoke API access to your Media Shuttle account, click Regenerate API key.

Management API

Media Shuttle Management API automates tasks performed using the IT Administration or Operations Administration Console. The Management API allows automated portal management, user account management, and provides information about active transfers.

All Media Shuttle subscriptions include Media Shuttle Management API.

Workflow Example - Creating a New Portal

The following image outlines the general workflow for creating a new portal using the Media Shuttle Management API.

Media Shuttle Create a New Portal Workflow

Workflow Example - Viewing Active Transfers

The /transfers endpoint allows you to view transfer activity across all portals, including details about the transfer state and protocol, as well as the transfer rate, current file, and more.

Media Shuttle View Active Transfers Workflow

System-to-Person Automation API

The System-to-Person API integrates Media Shuttle with other systems in your media technology workflow, including other Signiant applications.

Automated workflows driven by Signiant Manager+Agents or Jet can deliver content from systems to individual users. Other systems such as a DAM or MAM can integrate Media Shuttle to your workflow for fast, easy, and secure content exchange.

Contact us today to learn more about the System-to-Person Automation API

Webhooks

Signiant’s System-to-Person API allows you to create webhooks that authorize your application to receive information about portal events.

Webhooks send subscription updates to a URL when a transfer finishes.

Learn more about System-to-Person webhooks

Workflow Example - Creating an Upload/Download Token

The following image outlines the general workflow for creating an upload or download token for a Share Portal using the Media Shuttle System-to-Person Automation API.

Media Shuttle Upload Download Token Workflow