PHP 인터페이스 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

또한 보기: http://wiki.zanox.com/en/Web_Services

또한 보기: http://apps.zanox.com

저자: Thomas Nicolai ([email protected])

저자: Lars Kirchhoff ([email protected])

파일 보기 프로젝트 열기: fubralimited/php-oara

공개 메소드들

메소드	설명
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.

메소드 상세

getConnectId() 공개 메소드

Returns connectId

public getConnectId ( ) : string
리턴	string	zanox connect id

getNonce() 공개 메소드

Returns nonce.

또한 보기: http://en.wikipedia.org/wiki/Cryptographic_nonce

public getNonce ( ) : string
리턴	string	nonce

getPublicKey() 공개 메소드

Returns the public key

public getPublicKey ( ) : string
리턴	string	zanox public key

getSignature() 공개 메소드

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
리턴	string	encoded string

getTimestamp() 공개 메소드

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 HTTP RFC for the datetime format

public getTimestamp ( ) : string
리턴	string	message timestamp

isSecureApiCall() 공개 메소드

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

public isSecureApiCall ( ) : boolean
리턴	boolean	true if secure message

setConnectId() 공개 메소드

Set connectId

public setConnectId ( string $connectId ) : void
$connectId	string	zanox connectId
리턴	void

setPublicKey() 공개 메소드

Sets the public key.

public setPublicKey ( string $publicKey ) : void
$publicKey	string	public key
리턴	void

setSecretKey() 공개 메소드

Set SecretKey

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

setSecureApiCall() 공개 메소드

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

public setSecureApiCall ( $status = false ) : void
리턴	void

setTimestamp() 공개 메소드

Set connectId

public setTimestamp ( string $timestamp ) : void
$timestamp	string	time stamp
리턴	void

setVersion() 공개 메소드

Sets the API version to use.

public setVersion ( string $version ) : void
$version	string	API version
리턴	void