Developer "How Do I?" FAQ

Expand All

Collapse All

Back End

Upload a document?

You have several options. You can either sign into your account upload them your computer or from a URL in the Vuzit Dashboard. You can also upload them from your computer with VuzitCL the command-line client for uploading documents to Vuzit or you can programmatically upload them. Below are examples for several programming languages. [link]

• Client library links: PHP | .NET | Ruby | Java

Search for a document?

Search is handled through the Document web API. You can quickly access this data through the "find all" methods of your preferred programming language. [link]

• Client library links: PHP | .NET | Ruby | Java

List all documents in my repository?

By using the document web service or with a client library with the "find all" method. Just send in a request with no parameters. [link]

• Client library links: PHP | .NET | Ruby | Java

Upload documents via SSL?

You need to set the "service URL" programmatically with your programming tool. The Vuzit SSL domain URL is https://ssl.vuzit.com. [link]

• Client library links: PHP | .NET | Ruby | Java

Trap errors and fix them?

All errors are loaded though a standard exception class. See the client library for your development environment for more information. [link]

• Client library links: PHP | .NET | Ruby | Java

Load analytics data?

The Vuzit Events API has this capability. [link]

• Client library links: PHP | .NET | Ruby | Java

Load up a thumbnail image or individual page of a document?

The Vuzit Image API provides this feature. [link]

Generate and use a public key?

You can create a key for yourself by signing up for an Enteprise On-Demand account. You will use the key to create a signature in the web service. See the client library links for more information. [link]

• Client library links: PHP | .NET | Ruby | Java

Delete a document?

Use the Documents API destroy method to accomplish this. [link]

• Client library links: PHP | .NET | Ruby | Java

Upload a document directly from a database?

Use the upload method of one of the Vuzit open source client libraries. [link]

• Client library links: PHP | .NET | Ruby | Java

Load up text from a document and put it into a web page so search engines will pick it up?

Use the Pages API to export any or all of the document text into a web page so that Google will find and index it. [link]

• Client library links: PHP | .NET | Ruby | Java

Load and retrieve analytics data about a single user?

Use the Javascript fromID method to input their users name into the document with the custom option upon load. Then use the Events API to retrieve it by passing in the custom option. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Viewer.fromId

Delete all documents that are 24 hours old?

Use the Documents API destroy method to delete all documents that you've added to the system that are older than 24 hours. [link]

• Client library links: PHP | .NET | Ruby | Java

Get the title of a document?

Call the get title method with one of the Vuzit open source client libraries. Alternatively you can call the getTitle method of the Javascript library. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Document.getTitle

Get the status of a document. If it's been converted yet?

Call the get status method of one of the Vuzit open source client libraries. Alternatively use the isProcessingSuccess function of the Javascript library. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Document.isProcessingSuccess

Load document metadata?

Use any of the Document class methods of one of the Vuzit open source client libraries. Alternatively use the same methods from the Javascript Document class methods. [link]

• Client library links: PHP | .NET | Ruby | Java

Upload a large number of documents at one time?

Write an application with one of the Vuzit open source client libraries that loads up all of your documents from a directory or database and collects the IDs so that they can be viewed later. [link]

• Client library links: PHP | .NET | Ruby | Java

How do I handle authentication?

Vuzit uses Hash-based Message Authentication Code (HMAC) also used by the Amazon Web Services Platform. It allows you to give a user of your choosing access to a document for a brief period of time. The default time is 15 minutes. After the time period is over your system must re-authorize them to view the document again. The authentication is determined by your own authentication protocols so there's no integration required for Vuzit. See the signature examples of the Vuzit client libraries for more information. Choose the appropriate link below. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Viewer.fromId

Front End

Provide a URL to the original document?

Use the Documents API for this. [link]

• Client library links: PHP | .NET | Ruby | Java

Provide a URL to the PDF version of an electronic document I've uploaded?

Use the Documents API for this. [link]

• Client library links: PHP | .NET | Ruby | Java

Show a private document to just a single user?

See the client library documentation below for more information. [link]

• Client library links: PHP | .NET | Ruby | Java

Show just certain pages (a preview) of a document?

Any of the Vuzit open source client libraries can accomplish this. See the documentation for your language. The Javascript documentation for this is on the Document previews page of the web site. [link]

• Client library links: PHP | .NET | Ruby | Java

Make the viewer show the download or print PDF icons in the toolbar?

See the upload method. You can either in the Dashboard choose the option to "Allow download" or "Allow PDF printing". The other option if using a client library is to supply the download_document and/or download_pdf options. See the client library documentation for more information. [link]

• Client library links: PHP | .NET | Ruby | Java

Add a watermark?

Read the digital watermark documentation for an explanation. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Viewer.fromId

Embed a document?

See the Vuzit Javascript starter tutorial. [link]

Switch pages programmatically?

Use the Javascript setPageNumber function. [link]

• Javascript link: vuzit.Viewer.setPageNumber

Get the number of pages in a document?

Use the get page number method of one of the Vuzit open source client libraries. Alternatively you can call the getPageCount method of the Javascript library. [link]

• Client library links: PHP | .NET | Ruby | Java
• Javascript link: vuzit.Document.getPageCount

Load a document by URL?

Use the Javascript fromUrl function. [link]

• Javascript link: vuzit.Viewer.fromUrl

Load a document by ID?

Use the Javascript fromId function. [link]

• Javascript link: vuzit.Viewer.fromId

Set the zoom level?

Use the setZoom function of the Javascript library. [link]

• Javascript link: vuzit.Viewer.setZoom

Set the size of a viewer?

Use the setSize function of the Javascript library. [link]

• Javascript link: vuzit.Viewer.setSize

Clean up the memory of a viewer?

Use the destroy function of the Javascript library. [link]

• Javascript link: vuzit.Viewer.destroy

Hide a document?

Use the hide function of the Javascript library. [link]

• Javascript link: vuzit.Viewer.hide

Switch documents in a viewer inline?

Use the setId function of the Javascript library. [link]

• Javascript link: vuzit.Viewer.setId

Load a viewer after the page has loaded?

Vuzit, like Google Maps, needs the page to be loaded for it to function. You can use the HTML body onload attribute but what is better is to use a Javascript framework to do it. For jQuery it's the $(window).load method and for Prototype it's the Event.observe(window) method. [link]

Upload files to my server then to Vuzit?

There are multiple examples (PHP, ASP.NET, Ruby) for each development environment. [link]

Tell when a page has been changed by a user?

You can use the onPageChanged event option of the Javascript display function. [link]

• Javascript link: vuzit.Viewer.display

Highlight words (start searching) once the page loads?

Use the searchSet to start the highlighting. Afterwards you can use the searchNext, searchPrevious and searchClear methods. [link]

• Javascript link: vuzit.Viewer.searchSet