ePages 7.28.0 - DE_EPAGES/MultiStoreConnector/API/JSONRestClient.pm

Package DE_EPAGES::MultiStoreConnector::API::JSONRestClient

Generic client for RESTful web services using JSON messages.

Functions

baseURL
decodeResponse
new
request

baseURL

returns the base url from the rest client

Syntax
$BaseURL = $Client->baseURL();
Return
$BaseURL (string)
base url from the rest client

decodeResponse

decodes information from a HTTP response object seperately.

Syntax
$ResponseData = $Client->decodeResponse($Response);
Input
$Response (HTTP::Response)
response object
Return
$ResponseData (ref)
decoded response data

new

Creates a new REST client object.

Syntax
$Client = DE_EPAGES::MultiStoreConnector::API::JSONRestClient->new( $BaseURL, $hptions );
Input
$BaseURL (string)
base URL
$hOptions (ref.hash)
  • UserAgent - user agent object (default: LWP::UserAgent) - object
  • Codec - content-type codec (default: DE_EPAGES::WebService::API::JSONCodec) - object
  • BasicAuthentication - basic authentication parameters [ login, password ] - ref.array
Return
$Client (DE_EPAGES::MultiStoreConnector::API::JSONRestClient)
client object

request

Executes a REST request.

Syntax
$ResponseData = $Client->request($Method, $SubPath, $RequestData);
Input
$Method (string)
HTTP method
$SubPath (string)
String to append to the BaseURL
$RequestData (ref)
request data
Return
$ResponseData (ref)
decoded response data