Skip to content
bmatzelle edited this page Oct 18, 2010 · 17 revisions

VuzitRuby – Vuzit Web Services library for Ruby

INTRODUCTION

This is a library that allows developers to directly access the Vuzit Document Viewer Web Service API through a simple Ruby script.

Below is a basic upload example:


require "vuzitruby"  

Vuzit::Service.public_key = 'YOUR_PUBLIC_API_KEY'
Vuzit::Service.private_key = 'YOUR_PRIVATE_API_KEY'

doc = Vuzit::Document.upload("c:/path/to/document.pdf")

puts "Document id: " + doc.id  

To get started you need to signup for a Vuzit account which gives you full access to the Vuzit APIs. Then simply replace your public and private keys in your code, and you’re ready to go.

SETUP

The client library is a RubyGem called vuzitruby. To install, run the following command:


gem install vuzitruby

You can also download the gem as a zip or Ruby gem.

GETTING STARTED

LICENSE

Released under the open source MIT license which allows you to use it in any proprietary product.

MORE INFORMATION

For more information visit the Vuzit.com developer center

FEATURE REQUESTS AND BUG REPORTS

Email to support@vuzit.com or visit Vuzit Support