NAME
WebService::Hexonet::Connector::Connection - package to provide API client functionality.
DESCRIPTION
This package provides any API client functionality that you need to communicate with the insanely fast HEXONET Backend API. A short hand method to instantiate the API client is provided as WebService::Hexonet::Connector::connect and its usage is described in that appropriate file.
The API client library itself cares about requesting provided commands to the Backend API by using the given configuration data (credentials, backend system url and entity) and to return the Backend API response accordingly.
METHODS WebService::Hexonet::Connector::Connection
new(config)
-
Create an new API client instance with the given configuration data. Supported configuration data keys are: - login - your uid - password - your password - url - Backend API url to use; in general https://coreapi.1api.de/api/call.cgi - entity - Backend system entity; use "54cd" for LIVE system and "1234" for OT&E system - user - to have a view into subuser account data - role - in case you want to login with a role user account that is directly under the given uid
call(command, config)
-
Make a curl API call and returns the response as a response object
call_raw(command,config)
-
Make a curl API call and returns the response as a string
call_raw_http(command, config)
-
Make a curl API call over HTTP(S) and returns the response as a string
AUTHOR
Hexonet GmbH
LICENSE
MIT