PHP Interface IAuthorization

The IAuthorization Interface defines the methods that need to be implemented in order to support the required hash-based signing of messages. Supported Version: PHP >= 5.0

See also: http://wiki.zanox.com/en/Web_Services

Public Methods

Method	Description
getConnectId ( ) : string	Returns connectId
getNonce ( ) : string	Returns nonce.
getPublicKey ( ) : string	Returns the public key
getSignature ( string $service, string $method, string $nonce ) : string	Returns the crypted hash signature for a api message.
getTimestamp ( ) : string	Returns the current REST timestamp.
isSecureApiCall ( ) : boolean	Returns message security status.
setConnectId ( string $connectId ) : void	Set connectId
setPublicKey ( string $publicKey ) : void	Sets the public key.
setSecretKey ( string $secretKey ) : void	Set SecretKey
setSecureApiCall ( $status = false ) : void	Enables the API authentication.
setTimestamp ( string $timestamp ) : void	Set connectId
setVersion ( string $version ) : void	Sets the API version to use.

Method Details

getConnectId() public method

Returns connectId

public getConnectId ( ) : string
return	string	zanox connect id

getNonce() public method

Returns nonce.

See also: http://en.wikipedia.org/wiki/Cryptographic_nonce

public getNonce ( ) : string
return	string	nonce

getPublicKey() public method

Returns the public key

public getPublicKey ( ) : string
return	string	zanox public key

getSignature() public method

Builds the signed string consisting of the rest action verb, the uri used and the timestamp of the message. Be aware of the 15 minutes timeframe when setting the time manually.

public getSignature ( string $service, string $method, string $nonce ) : string
$service	string	service name or restful action
$method	string	method or uri
$nonce	string	nonce of request
return	string	encoded string

getTimestamp() public method

If there hasn't already been set a datetime we create one automatically. As a format the HTTP Header protocol RFC format is taken.

See also: see HTTP RFC for the datetime format

public getTimestamp ( ) : string
return	string	message timestamp

isSecureApiCall() public method

Method returns true if message needs to signed with crypted hmac string and nonce. Otherwise false is returned.

public isSecureApiCall ( ) : boolean
return	boolean	true if secure message

setConnectId() public method

Set connectId

public setConnectId ( string $connectId ) : void
$connectId	string	zanox connectId
return	void

setPublicKey() public method

Sets the public key.

public setPublicKey ( string $publicKey ) : void
$publicKey	string	public key
return	void

setSecretKey() public method

Set SecretKey

public setSecretKey ( string $secretKey ) : void
$secretKey	string	zanox secret key
return	void

setSecureApiCall() public method

Authentication is only required and therefore enabled for some privacy related methods like accessing your profile or reports.

public setSecureApiCall ( $status = false ) : void
return	void

setTimestamp() public method

Set connectId

public setTimestamp ( string $timestamp ) : void
$timestamp	string	time stamp
return	void

setVersion() public method

Sets the API version to use.

public setVersion ( string $version ) : void
$version	string	API version
return	void