DOCSEARCHbyAlgolia
Submit Docs

Signiant Developer Documentation

website·Indexed 35 days ago

https://developer.signiant.com/

Technical documentation and API references for Signiant products, including Media Shuttle (Management and Platform APIs, TypeScript SDK), Jet (automation API and webhooks), Flight Deck (REST and SOAP APIs, FIMS), and the Signiant Platform and Verify APIs. Covers job scheduling, bandwidth management, webhook integration, and asset distribution workflows.

Tokens
30.1K
Snippets
127
Records
186
Agent score
58%

What's inside Signiant

  1. Overview of Signiant Media Shuttle APIs

    Signiant Media Shuttle provides two primary API sets for integration:

    1. Media Shuttle Management API: Used to integrate MAM/DAM software and custom applications with send, share, and submit portals associated with a Media Shuttle account.
    2. System-to-Person API: Enables portal users to send and receive files via automatically distributed upload or download links for content acquisition and distribution.

  2. Overview of System-to-Person Webhooks

    The System-to-Person (S2P) API allows developers to subscribe to webhooks that send JSON notifications about transfer events, token actions, and file operations. To use these resources, an account must have a System-to-Person API subscription. When creating a subscription via the API or during token generation, a valid destination URL is required. Note that if notifications are enabled at multiple levels, duplicate notifications for the same event may be received.

  3. Overview of the Signiant Platform API

    The Signiant Platform API enables developers to integrate third-party applications with the Signiant Platform. It allows for sending requests and receiving responses to perform actions that are typically managed through the Signiant Console interface.

  4. Overview of the Media Shuttle SDK

    The Media Shuttle SDK is a TypeScript-based development module for Enterprise subscribers to build high-speed transfer applications for uploading to and downloading from Media Shuttle Share portals. It enables authentication via the Signiant Platform, account and portal selection, browsing portal contents, and accelerated transfers.

    Requirement: The Signiant App must be installed on the client machine to perform the actual upload and download of files.

  5. Overview of Media Shuttle API options

    Media Shuttle provides three distinct APIs depending on the automation goals:

    • Platform API: Used for app integrations to control the lifecycle of a portal, including creation, customization, and deployment via the Signiant Console and Media Shuttle SDK.
    • Management API: Included in all subscriptions. Used by IT or Operations Administrators to retrieve active transfer info, create portals, and manage storage and users.
    • System-to-Person (S2P) Automation API: A licensed add-on feature used to create upload/download links and subscribe to notification events via webhooks.

  6. Overview of Flight Deck FIMS API

    The Flight Deck FIMS API is based on the FIMS 1.1 standard, allowing orchestration systems to invoke Signiant workflows. It supports both SOAP (via WSDL) and REST interfaces. To use the API, Signiant Manager must be installed. REST function examples are provided in the Signiant Manager installation bundle under the /support/fims_samples directory.

  7. Access and authenticate with the Flight Deck Manager REST API

    The Manager API is used to automate jobs, manage users, and control storage settings. Requests are made directly to the Manager instance. The default Administrator account has automatic access. For other users, API access is enabled by navigating to Administration > Users > List and selecting the Administration Interface Login role under Roles.

    Base URL: https://your.manager.url/signiant/spring/admin/v1.0/

  9. Understand the Media Engine webhook metadata payload

    When a webhook is triggered, it sends a JSON payload containing details about the trigger and the associated asset. This includes the webhookId, the user who triggered it, and a comprehensive item object containing file paths, technical metadata (codec, bitrate, resolution), storage profile information, and HLS stream URLs.
    {
  "webhookId": "50fe1ec8-1234-4628-b17c-0e57883a1453",
  "triggeredBy": "user@example.com",
  "triggeredOn": "2025-04-01T18:22:01.653Z",
  "item": {
    "itemId": "362e522f-1234-449e-1234-2e448f71de15.2bfcb6a4d97a4cee9c679076f50867dd",
    "filePath": "/path/to/example/example-video.mp4",
    "filename": "example-video.mp4",
    "fileSize": 42032695,
    "contentType": "video/mp4v-es",
    "lastModifiedOn": "2025-01-31T18:36:32.076Z",
    "accountId": "12345678-abcd-1234-abcd-123451234512",
    "technicalMetadata": {
      "state": "complete",
      "format": "MP4",
      "bitRate": 13461567,
      "duration": { "value": 25.8115 },
      "video": {
        "codec": "H.264",
        "bitRate": 13338267,
        "frameRate": { "value": 60, "numerator": 60, "denominator": 1 },
        "width": 1884,
        "height": 906,
        "displayWidth": 1884,
        "displayHeight": 906,
        "scanType": "progressive",
        "pixelFormatInfo": "YUV 4:2:0 8 bit",
        "profile": "Main",
        "level": "4.2"
      },
      "audio": {
        "codec": "AAC",
        "bitRate": 129817,
        "layout": "1.0 Mono",
        "sampleRate": 48000
      }
    },
    "resources": {
      "thumbnail_240": {
        "state": "complete",
        "url": "https://storage-indexing-resources..."
      }
    },
    "storage": {
      "storageProfileId": "362e522f-6ab5-449e-a3f4-2e448f71de15",
      "storageProfileType": "ON_PREMISE_FILE_STORAGE",
      "name": "Example SDCX Server"
    },
    "hlsStream": {
      "playlistUrl": "https://media-engine-play-sdcx...",
      "state": "available"
    }
  }
}

  10. Understand Signiant FIMS job workflows and Job Groups

    Signiant jobs are created based on configured workflows, which act as templates containing variables and default values. When a job is created from a workflow, it is automatically stored within a Job Group. By default, the FIMS API utilizes a preset workflow and Job Group for all submitted jobs.

  11. Media Shuttle Portal Asset object reference

    When managing portal assets, the API returns asset objects containing metadata about the uploaded file, including its storage location, dimensions, and state.
    {
  "storageLocation": {
    "bucket": "signiant-provided-storage-bucket",
    "region": "us-east-1",
    "path": "portals/11111111-150c-1111-9827-d101312aba20/public/11111111-94a3-1111-9cc7-7780da375e95.png"
  },
  "accountId": "1111111-11111-42f8-9f35-907934f744b3",
  "mimeType": "image/png",
  "downloadUrl": "https://example.com/portals/11111111-150c-1111-9827-d101312aba20/public/11111111-94a3-1111-9cc7-7780da375e95.png",
  "sigUpdateRegion": "us-east-1",
  "state": "READY",
  "uploadedOn": "2022-09-23T17:12:39.489Z",
  "lastModifiedOn": "2022-09-23T17:12:39.489Z",
  "sizeInBytes": "4259",
  "isInUse": false,
  "assetId": "11111111-94a3-4084-9cc7-7780da375e95",
  "createdOn": "2022-09-23T17:11:50.435Z",
  "dimensions": {
    "width": 160,
    "height": 46
  },
  "serviceId": "11111111-0470-4cf4-913b-897d821ef7f6",
  "msAccountId": "11111111-29cd-4dde-b84e-81901376f1b2",
  "portalId": "11111111-150c-4214-9827-d101312aba20",
  "description": "Example Logo",
  "type": "LOGO"
}

  12. Integrate third-party services using Media Engine Webhook Actions

    Media Engine supports third-party integrations via webhook actions created through the Signiant Platform API. Once an asset is indexed and a webhook action is configured, the system can collect asset metadata and send it to a specified third-party service.