Template Credentials

As discussed in our concepts, Transloadit can export files to your cloud bucket or server. To authenticate, we'll need credentials (write-only if possible). You can set these directly in your import and export Robot parameters (often via key and secret), but, as of 2018, we recommend that you use Template Credentials instead. With Template Credentials, you store the credentials separately, and then refer to them by name via the credentials Robot Parameter. You can check the individual Robot docs for more information.

We have created Template Credentials, so you can:

  • Enjoy stronger encryption and protection (viewing credentials requires password re-entry).
  • Easily reuse your credentials across several Templates.
  • Easily share Templates with us without having to redact credentials each time.
  • Be more liberal in sending Assembly Instructions directly (without using a Template). Even though Templates are recommended, this allows prototyping without transmitting secrets every time.
  • Revoke leaked credentials and replace them without modifying all your Templates or code.
  • Add tokens. Some cloud providers require an interactive "oAuth dance" in order to give Transloadit access. The web interface for Template Credentials allows for this.

Here are Assembly Instructions using Template Credentials that were previously saved in your account as my_s3_credentials and my_youtube_credentials. It imports videos from an S3 bucket and uploads them to YouTube:

{
  "steps": {
    "imported": {
      "robot": "/s3/import",
      "credentials": "my_s3_credentials",
      "path": "/some/path"
    },
    "exported": {
      "robot": "/youtube/store",
      "use": "imported",
      "credentials": "my_youtube_credentials"
    }
  }
}

How to create Template Credentials

  1. Go to your Workspaceʼs Credentials page.
  2. Choose your cloud provider from the dropdown menu at the top of the page and fill out all the fields for bucket names, keys and secrets.
  3. Give your Template Credentials a name for future reference in your Templates and hit save.

You can now set the name as the credentials property in your export Robot.