PHP Class ApiAuthorization

Datei anzeigen Open project: fubralimited/php-oara

Public Methods

Method	Description
__construct ( ) : void	Contructor
getConnectId ( ) : string	Returns the connectId
getNonce ( ) : string	Returns hash based nonce.
getPublicKey ( ) : string	Returns the public key
getSignature ( string $service, string $method, string $nonce ) : string	Returns the crypted hash signature for the message.
getTimestamp ( ) : string	Returns the current REST timestamp.
isSecureApiCall ( ) : boolean	Returns message security status.
setConnectId ( string $connectId ) : void	Set the 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.

Private Methods

Method	Description
encodeBase64 ( string $str ) : encoded	Encodes the given message parameters with Base64.
hmac ( $mesgparams ) : string	Creates secured HMAC signature of the message parameters.

Method Details

__construct() public method

Contructor

public __construct ( ) : void
return	void

getConnectId() final public method

Returns the connectId

final public getConnectId ( ) : string
return	string	zanox connect id

getNonce() final public method

Returns hash based nonce.

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

final public getNonce ( ) : string
return	string	md5 hash-based nonce

getPublicKey() final public method

Returns the public key

final public getPublicKey ( ) : string
return	string	zanox public key

getSignature() final 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.

final 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() final 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

final public getTimestamp ( ) : string
return	string	message timestamp

isSecureApiCall() final public method

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

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

setConnectId() final public method

Set the connectId

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

setPublicKey() final public method

Sets the public key.

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

setSecretKey() final public method

Set SecretKey

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

setSecureApiCall() final public method

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

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

setTimestamp() final public method

Set connectId

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

setVersion() final public method

Sets the API version to use.

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