> Support

Sign In:

Pomfort Account
account.pomfort.com
Pomfort ShotHub
shothub.pomfort.com
  Menu
  • Updates:
  • News
  • Blog
  • Events
  • Media Asset Management:
  • Silverstack Lab
  • Silverstack + XT
  • Offload Manager
  • SealVerify
  • Digital Imaging:
  • Livegrade Studio
  • Livegrade Pro
  • Cloud Services:
  • ShotHub
  • Pomfort Account
  • Solutions:
  • On-Set Solution
  • Facility Solution
  • Workflow:
  • Looks on Set
  • Virtual Production
  • ACES
  • ZEISS
  • White Papers
  • Store:
  • Pomfort Online Store
  • Support:
  • Knowledge Base
  • Downloads
  • Training
  • Contact
  • References:
  • Customers + Projects
  • Company:
  • About us
  • Network
  • Careers
  • Press
  • Products
  • Solutions
  • References
  • Blog
  • Store
  • Support
  • Support
  • Knowledge Base
  • ShotHub
  • Products
    • Overview
    • Media Asset Management
      • Overview
      • Silverstack Lab
        • Overview
        • What is new?
        • Use Cases
        • Videos
        • Features
        • Buy Now
        • Free Trial
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Silverstack + XT
        • Overview
        • What is new?
        • Use Cases
        • Videos
        • Features
        • Buy Now
        • Free Trial
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Offload Manager
        • Overview
        • Videos
        • Features
        • Buy now
        • Free Trial
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • ShotHub
        • Overview
        • What is new?
        • Videos
        • Features
        • See Plans
        • Use for Free
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Sealverify
        • Overview
        • Free Download
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Digital Imaging
      • Overview
      • Livegrade Studio
        • Overview
        • What is new?
        • Features
        • Buy Now
        • Free Trial
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Livegrade Pro
        • Overview
        • What is new?
        • Use Cases
        • Videos
        • Features
        • Buy Now
        • Free Trial
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Cloud Services
      • ShotHub
        • Overview
        • What is new?
        • Videos
        • Features
        • See Plans
        • Use for Free
        • Login
          • Pomfort Account
          • Pomfort ShotHub
        • Newsletter
        • Data Policy
        • Imprint
        • Cancel Subscription
      • Pomfort Account
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Solutions
    • Overview
    • On-Set Solution
    • Facility Solution
      • Overview
      • Involved Products
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Workflow
    • Looks on Set
    • Virtual Production
    • ACES
    • ZEISS
    • Frame.io
    • White Papers
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Store
    • Overview
    • Buy Silverstack Lab
      • Licenses
      • Upgrade
      • Enterprise
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Buy Silverstack
      • Licenses
      • Upgrade
      • Enterprise
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Buy Offload Manager
      • Licenses
      • Upgrade
      • Enterprise
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Buy Livegrade Studio
      • Licenses
      • Upgrade
      • Enterprise
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Buy Livegrade Pro
      • Licenses
      • Upgrades
      • Enterprise
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Buy ShotHub
    • Apps + Tools
    • Enterprise
    • Resellers
    • Cart
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Blog
    • Recent Articles
    • DIT Cart Stories
    • Production Insights
    • Technology on Set
    • Product Know-How
    • Search
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • References
    • Overview
    • Made With Pomfort Products
    • Productions Insights
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Company
    • About us
    • News
    • Events
    • Network
    • Careers
    • Press
      • Overview
      • Press Releases
      • Press Material
      • In the Press
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Support
    • Overview
    • Knowledge Base
      • Silverstack & Silverstack Lab
      • Livegrade Pro & Studio
      • Pomfort Sealverify
      • ShotHub
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • FAQ
      • Before Buying
      • License Management
      • Purchasing Process
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Downloads
    • Video Tutorials
      • Silverstack & Silverstack Lab
      • Livegrade Pro & Studio
      • ShotHub
      • Login
        • Pomfort Account
        • Pomfort ShotHub
      • Newsletter
      • Data Policy
      • Imprint
      • Cancel Subscription
    • Training
    • Contact
    • Login
      • Pomfort Account
      • Pomfort ShotHub
    • Newsletter
    • Data Policy
    • Imprint
    • Cancel Subscription
  • Login
    • Pomfort Account
    • Pomfort ShotHub
  • Newsletter
  • Data Policy
  • Imprint
  • Cancel Subscription

Getting Started

Category: ShotHub API

ShotHub API (Beta)  v1.0 

Please note that the API is in beta status and subject to change. API access via scripts is available for all ShotHub user plans during the beta phase. After the beta period, scripts and access to the ShotHub API are exclusive features for users with a Team Plan.

Set up ShotHub API access.

Login to ShotHub through your browser, and import the sample projects “Hotel” (Livegrade) and “Birthday Cake” (Silverstack) or upload a library from one of the desktop applications in case you don’t have any cloud projects yet.

For security reasons, the ShotHub API can not be accessed with your regular user credentials but only through an application key associated with a script. To set up a script, open the Team Settings and go to the  team scripts tab. Enter a name, e.g., “DemoScript,” into the name field and click the “Create Script” button. A dialog like this will pop up:

Script ID and Key are generated

Store this information in a safe place, e.g., your password manager, then close the dialog. A script is “like a user,” i.e., its access is restricted to projects it has explicitly been added to and has a role within every project. Adding a script to a project is achieved through the “Add Script” dialog, which can be accessed via the button “i” next to the project name. Please add a script to at least one project before proceeding with this quick-start guide.

Add script to the project in the project info panel

Create and run an example script

Now we’re all set to run our first script. For this example, we are using Python – if you do not have Python 3 installed on your machine, please install it now. No additional libraries are required; this example should work on macOS, Linux and Windows.
You can download a sample script here: sample.py (zipped Python script, 1KB)

Insert the credentials (Script ID and Script Key) you noted in the “config” settings, and then run the script from the terminal. If all goes well, you’ll see the folder hierarchy of the project(s) to which you previously added the script.

Notes for building your own scripts

While we have chosen Python for our example script, the API is language-agnostic and can be consumed in any language which offers an HTTP client and a JSON parser.

Authentication and authorization

Access to the public API requires a JWT Bearer token, delivered in the Authorization header. For obtaining the JWT token, a POST request to https://api.pomfort.com/sh/authenticate must be made using the following document structure in the body:

Enter access credentials

If the credentials are correct, the response will look as follows:

An access token is generated

Reference documentation

A complete reference of the available endpoints and schemas can be found at https://shothub.pomfort.com/openapi/ui.html.
A Swagger definition can be found at https://shothub.pomfort.com/openapi/v3.


Feedback

We look forward to receiving your feedback on the API beta version. Please send your questions, suggestions, and criticisms to support@pomfort.com.

 

Back to Overview

Haven't found what you are looking for?

Search
Some of our customers:
HBO logo
Apple logo
Technicolor logo
Munhwa Broadcasting Company logo
Phenom Films logo

Stay up to date:

Sign up for our newsletter!

 

10 years logo

Get in contact:

contact@pomfort.com

contact form

Follow us:

  • Data Policy
  • Imprint
  • Careers
  • Training
  • Press
  • Company
  • Contact
  • Change Privacy Preferences
  • Cancel Subscription
7ads6x98y