Accessing ImpossibleFX Scripting

ImpossibleFX scripts always run a customer's computer and send the compiled Dynamic Movie Template to the ImpossibleFX Service. You can use a number of programming languages to create scripts. The most promonent way for running scripts is the Project Management Console, which lets you create and run scripts writtten in Javascript.

ImpossibleFX is a RESTful web service that uses HTTPS as the protocol and JavaScript Object Notation (JSON) and Google Protocol Bufffers (Protobuf) as the message format. Your application code can make requests directly to the ImpossibleFX API. When using the REST API directly, you must write the necessary code and authenticate your requests with a API Keys and API Secrets. For more information about the API and about authenticating requests, see Developer API Reference.

Contents

• Using the Project Management Console
• API Keys and API Secret
• Developer SDKs
• SDL Protocol Buffers Definition

Using the Project Management Console

ImpossibleFX provides a Project Management Console that has a built-in Javascript Editor and an integrated version of the FX Javascript SDK. You can use the console to perform all of the same operations that you can perform using the ImpossibleFX API with other languages.

To use the Project Management Console to create and manage ImpossibleFX Scripts using Javascript go to

https://console.impossible.io.

API Keys and API Secret

You should never access the ImpossibleFX APIs with your username and password. You should rather create an API key and secret and use it instead of the username and password. You can create as many keys as you like.

To create an API key and secret

1. Open the Project Management Console at
   https://console.impossible.io
2. Click on the account menu in upper right hand corner and select API Keys
3. Click on Create API Key and optionally enter a comment for this key.
4. Click on OK and note the Key and Secret on the screen.

Developer SDKs

If you are using a language for which an SDK exists, use the SDK rather than trying to work your way through the APIs. The SDKs make authentication simpler, integrate easily with your development environment, and provide easy access to ImpossibleFX commands. Alternatively, use the Javascript SDK in the Project Management Console.

See Developer Tools & SDKs

SDL Protocol Buffers Definition

The core service provides HTTP REST endpoints and you send requests to them. Movie templates are serialized to either JSON or to Google Protocol Buffers which allows you write templates in any language that can serialize to it. You can download the necessary Proto definition here:

https://github.com/ImpossibleSoftware/impossiblevideo-py/blob/master/Movie.proto