When working with Bright River as an External Post-Production Vendor, you can utilize our Gateway API to send assets between Bright River and Creative Force.
Bright River API Setup
Setting up Bright River using our Gateway API allows seamless communication between the vendor and Creative Force. In this article, we will walk through the steps to add a new vendor using the API method and outline what information will be needed to share and receive from Bright River throughout the process.
Add New Vendor
To get started, we will need to add a new vendor. Head to Studio Settings β External Post-Production β select Add β then set the Connection Type to 'Gateway API.'
Under Connection Settings, you will need to add a webhook URLβ this will effectively be the URL that images are delivered to.
π£οΈ Tip: The Webhook URL is provided by Bright River. If you do not already have it, please reach out to your Bright River account representative.
Once you have added the provided URL, click Save.' Creative Force will automatically generate a Secret Key in the field that populates below the Webhook field.
Copy the Secret Key and share it with Bright River so that they may proceed with the necessary configuration on their end. After completing the connection settings configuration, save and exit the vendor setup menu for now.
Register New App
For the next step, we will need to register a new application in Creative Force. This will allow Bright River to make the necessary API calls to Creative Force to complete the post-production process.
Head to Studio Settings β Registered Apps β 'Register App'
In the pop-up menu, fill out the required configuration fields for the app.
Configuration Field | Function |
Allowed Grant Type | For Bright River, this should be set to 'Client Credentials.' |
Application Name | Name the application. |
Application Description | Describe the application to help identify it. |
On Behalf User | Set an internal user that the application will take actions on behalf of. |
β οΈ Important: The assigned user needs to have adequate permissions. For more information, see our Recommended API User article here.
After saving the initial application registration fields, Creative Force will automatically generate an Application ID and a Secret Key. Share these with your Bright River account representative so that they can complete their configuration.
When you have collected the necessary information, you can save and close out of the registration menu.
Share Workspace ID
One final piece of information will be needed in order for Bright River to complete the configuration on their end, and that is the Workspace (Client) ID. The Workspace ID is a unique identifier that exists for each Workspace you've created.
To find it, head to Studio Settings β Workspaces β hover over the desired Workspace β then hit 'Edit.'
The Workspace ID will be listed under the initial Settings tab. Use the paper icon to copy it to your clipboard, then share it with your Bright River contact.
Specification Settings
For the final configuration step, we will need to return to the vendor we created earlier under Studio Settings β External Post-Production β 'Edit.'
Move to the 'Specification Settings' tab, where you will be able to configure a number of fields. The information added here will load into your Style Guides when configuring your templates in a later step.
π£οΈ Tip: Bright River will need to share a list of internal Specification IDs and Template names they have configured for you. If you do not have this information already, please reach out to your Bright River account rep.
Production Integration
After finishing all of the above setup and configuration, we are now ready to start integrating your new Bright River vendor into your studio productions.
Add to Workflows
Head to Studio Settings β Workflows β then, in a new or existing Workflow, add the new vendor you created as an option for your Post-Production steps.
For more information on adding and configuring vendors in Workflows, please see our dedicated article on the subject at the link below.
Map Templates to Style Guide
Head into any Style Guides connected to the Workflows you have added the new vendor to. From here, click into the External Post section of the Style Guide for each related Production Type.
Based on the options added in the Specification Settings section of this article, Bright River templates will be available to map as Presets to your photography positions and assets.
Resource File Handling
There are two types of files that can be sent to Post Production: the main images that need editing, and supporting resource files that are used to aid in the editing of the main image. Resource files might be used for colour accuracy, composites, or ghost mannequin effects.
When sending these different files to Bright Riverβs system, we will send them in slightly different URL strings so that Bright River will know the purpose of the respective files and which ones to return.
Below is a breakdown of the URL strings based on the type of image that we are sending.
File Type | Description | URL Format |
Main Image | The main image that needs to be edited and sent back to Creative Force. | URL will include the value 'imageURL' in the string. |
In-clip Files | Supporting files that are needed to help create Ghost Mannequin composite images.
Learn more here. | URL will include one of the following values in the string:
|
Colour References | Supporting files that are sent to help ensure the colour accuracy of a given product.
Learn more here. | URL will include the value 'imageURLGroup' in the string. |
Resource Files | General supporting files that you may need to send from time to time to a vendor, but do not need to be in a set process. Learn more here | URL will include the value 'additionalResourceFileURLGroup' in the string. |
Based on the above logic, Bright River will know which images need to be returned and the purpose of the supporting files.




