The Widget API

Our Widget API is what powers the TweekIT demo - if you have not checked out our Demo click here - don’t worry we will wait.

Our Widget is just a small taste of power and flexibility TweekIT has to change your workflow, simplify your media file type woes, and convert your files to more common types. Want even more examples of the TweekIT power take a moment to check out our Use Cases here .

Read on for more information and insight into how the Widget works and what the API allows you to do.

The Widget and our Rest Api

Our Widget takes full advantage of our tweekit REST API to provide you with an easy to use visual tool to perform image transformations.

Want to use the Widget on your site? First you need to register an account, it’s free and painless click here to create an account.

Widget Installation

Once you have an account you will need Register your widget so you can generate a domain specific AppID - this just takes a moment. Click here to start the process, the only information we require is the domain where you are going to host the Widget, and your user account.

To register your Widget you will need to enter the full domain for your site eg: www.yoursitename.com once you have done so, you will be able to generate the App Token and Widget Code. You will then use the Widget code to register your Widget from your site, and the Widget API to control it.

If you look at the example to your right you will find a section of the code in the Body of the example where there is an appId with value. You can replace this code with your AppID code if you want to host and experiment with this example from your own domain.

Read on for all the details to allow you to customize your widget to your use case. The following sections explore how to expand the functionality of your Widget, to allow it to replicate as much or as little of our Demo as you desire. We provide the tool and the API, the skys the limit as to what you do with it.

Enjoy, and if you run into issues take a moment to contact us , we are here to help

Example


    <div id="tweekit-box">
    </div>

    <script>
        var tweekit = new Tweekit('#tweekit-box', {
            appId: '{ your app ID }'
        })

    </script>