Vuzit_Service

Global data class.

Summary
Vuzit_ServiceGlobal data class.
Variables
PublicKeyThe Vuzit public API key.
PrivateKeyThe Vuzit private API key.
ServiceUrlThe URL of the Vuzit web service.
Functions
getSignatureReturns an array of the signature and the timestamp (integer).

Variables

PublicKey

public static $PublicKey

The Vuzit public API key.

Example

Vuzit_Service::$PublicKey = 'YOUR_PUBLIC_API_KEY';

PrivateKey

public static $PrivateKey

The Vuzit private API key.  Do NOT share this with anyone!

Example

Vuzit_Service::$PrivateKey = 'YOUR_PRIVATE_API_KEY';

ServiceUrl

public static $ServiceUrl

The URL of the Vuzit web service.  This only needs to be changed if you are running Vuzit Enterprise on your own server.  The default value is “http://vuzit.com”.

Example

Vuzit_Service::$ServiceUrl = 'http://vuzit.yourdomain.com';

Functions

getSignature

public static function getSignature($service,  
$id =  '',
$time =  null)

Returns an array of the signature and the timestamp (integer).

Parameters

serviceName of the service: ‘show’, ‘create’, or ‘destroy’.
id(Optional) ID of the document.
time(Optional) Optional time stamp (e.g. time()).

Example

$timestamp = time();
$sig = Vuzit_Service::getSignature("show", "DOCUMENT_ID", $timestamp);
public static $PublicKey
The Vuzit public API key.
public static $PrivateKey
The Vuzit private API key.
public static $ServiceUrl
The URL of the Vuzit web service.
public static function getSignature($service,  
$id =  '',
$time =  null)
Returns an array of the signature and the timestamp (integer).
Close