https://github.com/ghostbar/transloadit-api

A Transloadit API library for Node.js
https://github.com/ghostbar/transloadit-api

Last synced: about 1 year ago
JSON representation

A Transloadit API library for Node.js

• Host: GitHub
• URL: https://github.com/ghostbar/transloadit-api
• Owner: ghostbar
• License: mit
• Created: 2014-01-27T10:22:23.000Z (over 12 years ago)
• Default Branch: master
• Last Pushed: 2019-10-18T23:27:55.000Z (over 6 years ago)
• Last Synced: 2025-03-27T03:41:35.366Z (over 1 year ago)
• Language: JavaScript
• Homepage: https://ghostbar.github.io/transloadit-api/
• Size: 1.54 MB
• Stars: 4
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
transloadit-api [![Build Status](https://secure.travis-ci.org/ghostbar/transloadit-api.png)](http://travis-ci.org/ghostbar/transloadit-api) [![Code Climate](https://codeclimate.com/github/ghostbar/transloadit-api/badges/gpa.svg)](https://codeclimate.com/github/ghostbar/transloadit-api)

===============

A Node.js library for Transloadit's API.

It has an interface for each of the available actions for Transloadit's API: assemblies, notifications and templates.

Assemblies Interface

--------------------

### Brief

    var tlib = require('transloadit-api');

    var assembly = new tlib.assembly(credentials);

    assembly.post(files, params, callback);

### assembly.post

The `post` method is used to upload files and it can take a single fileBlob or an array of them, then a JSON with the params accepted by Transloadit and finally a callback as the third argument.

    assembly.post(fileBlob, paramsAcceptedByTransloadit, function (err, response) {

      // Do whatever you want

    });

Quick-usage

-----------

    var config = {

      key: '...',

      'secret': '...'

    };

    var signature = require('transloadit-api').Signature(config);

    var params = {

      steps: {

        encode: {

          robot: "/video/encode"

        }

      }

    };

    var x = signature.create(params);

    /* now x has a signature for the given parameters */

    /* doing `console.log(x) would give */

    {

      signature: "fec703ccbe36b942c90d17f64b71268ed4f5f512",

      params: {

        auth: {

            expires: "2010/10/19 09:01:20+00:00",

            key: "2b0c45611f6440dfb64611e872ec3211"

        },

        steps: {

            encode: {

              robot: "/video/encode"

            }

        }

      }

    }

    /* uploading files or assemblies */

    var files = {

      'random.png': {

        name: 'Randomness.png',

        path: '/path/to/file'

      }

    };

    // files can be `req.files` directly too

    var upload = require('transloadit-api').Assembly(config);

    upload.post(files, params, function (err, res) {

      /* ... */

    });

Author

------

© 2014, Jose Luis Rivas ``

License

-------

The files are licensed under the MIT terms.

The image on `test/test-image.jpg` is released under the license [Creative Commons Attribution 4.0](http://creativecommons.org/licenses/by/4.0/)