Getting Started with Signiant Platform API

The Signiant Platform API allows developers to integrate third-party applications with the Signiant Platform to send requests and receive responses typically accessed through the Signiant Console interface.

Access is controlled by a client_id and client_secret that are associated with a specific role. Roles are associated with a specific product, account type, and service.

Product and service refer to the platform product being used to perform an action
Account type and role refer to the user type performing the action using the API

The roles available to API users depend on the product or service being used:

Product	Service	Account Type	Role
Flight Deck	`MANAGER_AND_AGENTS_SAAS`	Administrator	`MANAGER_AND_AGENTS_SAAS_ADMIN`
Flight Deck	`MANAGER_AND_AGENTS_SAAS`	End User	`MANAGER_AND_AGENTS_SAAS_VIEW_ONLY`
Flight Deck	`FLIGHT_GATEWAY`	Administrator	`FLIGHT_GATEWAY_ADMIN`
Jet	`S2S`	Administrator	`S2S_ADMIN`
Jet	`S2S`	End User	`JET_VIEW_ONLY`
Media Engine	`MEDIA_ENGINE`	Administrator	`MEDIA_ENGINE_IT_ADMIN`
Media Engine	`MEDIA_ENGINE`	End User	`MEDIA_ENGINE_USER`

For more information about user roles, see User Roles on the Signiant Platform.

To get a set of API credentials, contact Signiant Customer Care.

Authentication

The client_id and client_secret are used to generate an OAuth token that allows access to platform functions using a bearer token.

Generating an OAuth Token

To generate an OAuth token:

Ensure your computer can connect to all cloud.signiant.com domains by allowing firewall access to *.cloud.signiant.com.
Create a new JSON file specifying your Jet login credentials, client_id, client_secret, and client_credentials as the grant type:

{
  "client_id": "<your client_id>",
  "client_secret": "<your client_secret>",
  "grant_type": "client_credentials"
}

Save the file as credentials.json.
In your terminal or command prompt, navigate to the directory where credentials.json is saved.
Use the curl utility to call the /oauth/token endpoint:

curl -X POST -H "Content-Type: application/json" --data @credentials.json https://platform-api-service.services.cloud.signiant.com/oauth/token

After completing the request, the application returns a bearer token that is used to authenticate your API requests:

{
  "access_token": "<access_token>",
  "expires_in": 3600,
  "token_type": "Bearer"
}

Note: OAuth tokens expire one hour after they are created.

Storage

A storage profile defines a storage location associated with an endpoint that can be used by Signiant products.

Endpoints

An endpoint is a storage location that is used by Signiant to transfer files and perform platform operations. An endpoint is required to create a storage profile.

An endpoint can be an SDCX Server or a cloud storage location.

Note: Endpoints must be created using the Signiant Console.

Storage Profiles

A storage profile allows a Signiant product to transfer files to and from an endpoint by defining a directory on an SDCX Server, or by defining a cloud storage bucket or container.

Storage compatibility between products on the Signiant platform depends on the storage type:

Product	On-premises	AWS S3 Role ARN	Microsoft Azure	Google Cloud
Media Shuttle Transfers	Yes	Yes	Yes	Yes
Jet Transfers	Yes	Yes	Yes	Yes
Flight Deck Transfers	Limited	Yes	Manager Only	Manager Only
Media Engine Indexing	Yes	Yes	No	No

Note: Flight Deck cannot directly transfer to on-premises storage using an SDCX Server. Microsoft Azure and Google Cloud Storage are not available for Flight Deck via the Signiant Platform. For more information about configuring Flight Deck to use Microsoft Azure and Cloud Storage for Object Mover, see the Flight Deck Manager API Reference.

Webhook Actions

The Signiant Platform API also allows you to create webhook actions for use in Media Engine on the Signiant Platform.

A webhook action defined through the API sends metadata to a third-party recipient that contains file, content, and technical metadata.

For more information, see Media Engine Webhook Actions.