Templates allow you to store
In addition, this also allows
It's possible to overrule any parameter in a Template if you want to tweak things like an image
width based on a user interaction.
Go Async if Possible
We try our best to avoid having any encoding queues. Nevertheless, they sometimes (if rarely) happen and when that does, your users will have a negative experience if, in your integration, they have to wait on processing.
Users can also be sent on their way as soon as the upload completes. When using the jQuery SDK, that means
false, and making use of
When the processing is done, we ping your
notify_url, and you ping your user.
Notifications are a good way to obtain file results, because they allow you to specify a URL that Transloadit will use to contact you whenever an
Check your Robot's documentation
It's easy to take inspiration from library of demos, and copy paste them to get going quickly. Sometimes however
Use the latest encoding stack
Our customers would get upset if we upgraded our encoding software without telling them. Often there are backwards incompatible changes and so we keep old stacks around for a long time, giving our customers the change to upgrade when they are ready for it.
This does however put a burden on the customer to every now & again try out a newer stack. We recommend checking available encoding stacks at least once a year.
We currently recommend:
Secure your Requests
When, for example, your are integrating with us in your browser using our jQuery SDK, your auth key is publicly visible. Other people can read your
To prevent this, please consider enabling Signature Authentication if you integrate with us through browsers or other public channels.
In addition to this, use our HTTPS endpoints (
https://api2.transloadit.com) so instructions are encrypted in transit.
Don't give us the keys to your everything
Taking a few Security paradigms to heart, we'd like as little privileges as possible to do our work. In of us exporting to your Amazon S3 bucket for instance, it's perfectly possible to create an IAM user that only has write access. We're working very hard to make this very hard, but should Transloadit ever get compromised, we would like the worst case scenario to be that a few extra files being stored in your bucket.
Encode more files in less Assemblies
Assemblies are expensive on our platform, and to ensure performance for all, we have a
If possible, we recommend our customers to utilize that
Processing more files in less
Please consider also that one ZIP file, could result in tens of thousands of files when we extracting it.
Design for failure
We strive to provide a top-notch service with no downtime and zero crashed
If you keep the following things in mind, crashed
- *Enable automatic
Assembly Replaysin your account. You can do so here.
- Always use
Templates, otherwise automatic Assembly Replayswill not always work properly (because we obfuscate S3 credentials, etc. that come from request parameters, which even our own system can't decipher anymore when it wants to replay an Assemblyat a later stage).
- Design with the
Rate Limiterin mind. If you send us too many requests, we will rate limit them or even block your traffic entirely. You can learn about our Rate Limiters here.
- Implement retries on your end.
Use an SDK
We recommend using official Software Development Kits. SDKs come with many of these Best Practices out of the box. They often support