ePages 6.17.12 - DE_EPAGES/OAuthTokenClient/API/OAuth/OAuthTokenClient.pm

Package DE_EPAGES::OAuthTokenClient::API::OAuth::OAuthTokenClient

Client for OAuth access token operations.

Base
DE_EPAGES::EPagesJ::API::Object::RestClient

Functions

create
createToken
deleteToken
getToken
getTokens
new
saveToken

create

Factory method for a OAuthTokenClient object. Initializes based on the current configuration.

Syntax
$TokenClient = DE_EPAGES::OAuthTokenClient::API::OAuth::OAuthTokenClient->create;
Return
$TokenClient (DE_EPAGES::OAuthTokenClient::API::OAuth::OAuthTokenClient)
OAuthTokenClient object

createToken

Creates an OAuth token for a shop.

Syntax
$Token = $self->createToken( $ShopID, $hArgs );
Example
$Token = $self->createToken( $ShopID, {
    consumerKey => $Consumer->key,
    roles => [ 'sf' ]
});
Input
$ShopID (string)
Shop identifier (attribute WebServerScriptNamePart)
$hArgs (ref.hash)
POST body as hashref. required keys: consumerKey, roles
Return
$Token (DE_EPAGES::OAuthTokenClient::API::Object::OAuthAccessToken)
Token object

deleteToken

Deletes a token.

Syntax
$self->deleteToken( $ShopID, $Token );
Input
$ShopID (string)
shop identifier (WebServerScriptNamePart)
$TokenAlias (string)
token identifier

getToken

Gets a token.

Syntax
$AccessToken = $self->getToken( $ShopID, $Token );
Input
$ShopID (string)
shop identifier (WebServerScriptNamePart)
$Token (string)
OAuth token string
Return
$AccessToken (DE_EPAGES::OAuthTokenClient::API::Object::OAuthAccessToken)
token object

getTokens

Getsall Tokens for a Shop

Syntax
$self->getTokens($ShopID);
Input
$ShopID (string)
shop identifier (WebServerScriptNamePart)
Return
$TokenList (ref.array)
Tokenlist

new

Instanciates a new OAuthTokenClient.

Syntax
DE_EPAGES::OAuthTokenClient::API::OAuth::OAuthTokenClient->new( %args );
Input
%args (hash)
Input arguments. Possible keys.
  • TokensUriTemplate - url for tokens resource - DE_EPAGES::EPagesJ::API::Object::UriTemplate
  • TokenUriTemplate - url for single token resource - DE_EPAGES::EPagesJ::API::Object::UriTemplate
  • LogCategory - category for commlogger. Defaults to "OAuth" - string
Return
OAuthTokenClient (object)
new instance of OAuthTokenClient

saveToken

Calls service to save a token

Syntax
$Token = $self->saveToken( $ShopID, $Token );
Input
$ShopID (string)
shop identifier (WebServerScriptNamePart)
$Token (Object)
Token Object
Return
$Token (Object)
saved Token Object