HEXONET / WebService-Hexonet-Connector-1.01 / docs / apiconnector.html 
<html><head><title>WebService::Hexonet::Connector</title>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" >
</head>
<body class='pod'>
<!--
  generated by Pod::Simple::HTML v3.35,
  using Pod::Simple::PullParser v3.35,
  under Perl v5.026000 at Mon Jul 23 14:56:23 2018 GMT.

 If you want to change this HTML document, you probably shouldn't do that
   by changing it directly.  Instead, see about changing the calling options
   to Pod::Simple::HTML, and/or subclassing Pod::Simple::HTML,
   then reconverting this document from the Pod source.
   When in doubt, email the author of Pod::Simple::HTML for advice.
   See 'perldoc Pod::Simple::HTML' for more info.

-->

<!-- start doc -->
<a name='___top' class='dummyTopAnchor' ></a>

<h1><a class='u'
name="NAME"
>NAME</a></h1>

<p>WebService::Hexonet::Connector - Connector library for the insanely fast <a href="https://www.hexonet.net/" class="podlinkurl"
>Hexonet Backend API</a>.</p>

<h1><a class='u'
name="SYNOPSIS"
>SYNOPSIS</a></h1>

<pre>        ###############################
        # How to use this Library?
        ###############################

        # Install our module by
        cpan WebService::Hexonet::Connector
        # or
        cpanm WebService::Hexonet::Connector
        # NOTE: We suggest to use cpanm (App::cpanminus) for several reasons.

        # Import the Hexonet package
        use WebService::Hexonet::Connector;

        # Create a connection with the URL, entity, login and password
        # Use &#34;1234&#34; as entity for the OT&#38;E, and &#34;54cd&#34; for productive use
        # Don&#39;t have a Hexonet Account yet? Get one here: www.hexonet.net/sign-up
        my $api = WebService::Hexonet::Connector::connect({
                url =&#62; &#39;https://coreapi.1api.net/api/call.cgi&#39;,
                entity =&#62; &#39;1234&#39;,
                login =&#62; &#39;test.user&#39;,
                password =&#62; &#39;test.passw0rd&#39;,
        });

        # Call a command
        my $response = $api-&#62;call({
                command =&#62; &#34;querydomainlist&#34;,
                limit =&#62; 5
        });

        # Display the result in the format you want
        my $res = $response-&#62;as_list();
        my $res = $response-&#62;as_list_hash();
        my $res = $response-&#62;as_hash();

        # Get the response code and the response description
        my $code = $response-&#62;code();
        my $description = $response-&#62;description();</pre>

<h1><a class='u'
name="DESCRIPTION"
>DESCRIPTION</a></h1>

<p>This module allows to query the API and to deal with different response formats (list, list_hash, hash). It provides a short hand method (WebService::Hexonet::Connector::connect) to instantiate API clients.</p>

<p>A helper utility module is also included for tasks like date handling and string encoding.</p>

<h1><a class='u'
name="AVAILABLE_SUBMODULES"
>AVAILABLE SUBMODULES</a></h1>

<p>We&#39;ve split our functionality into submodules to give this module a better structure.</p>

<dl>
<dt><a name="WebService::Hexonet::Connector::Connection_-_API_Client_functionality."
><a href="http://search.cpan.org/perldoc?WebService%3A%3AHexonet%3A%3AConnector%3A%3AConnection" class="podlinkpod"
>WebService::Hexonet::Connector::Connection</a> - API Client functionality.</a></dt>

<dd>
<dt><a name="WebService::Hexonet::Connector::Response_-_API_Response_functionality."
><a href="http://search.cpan.org/perldoc?WebService%3A%3AHexonet%3A%3AConnector%3A%3AResponse" class="podlinkpod"
>WebService::Hexonet::Connector::Response</a> - API Response functionality.</a></dt>

<dd>
<dt><a name="WebService::Hexonet::Connector::Util_-_Bundle_of_Helper_methods."
><a href="http://search.cpan.org/perldoc?WebService%3A%3AHexonet%3A%3AConnector%3A%3AUtil" class="podlinkpod"
>WebService::Hexonet::Connector::Util</a> - Bundle of Helper methods.</a></dt>
</dl>

<h1><a class='u'
name="METHODS_WebService::Hexonet::Connector"
>METHODS WebService::Hexonet::Connector</a></h1>

<dl>
<dt><a name="connect(url,_entity,_login,_password,_user,_role)"
><code>connect(url, entity, login, password, user, role)</code></a></dt>

<dd>
<p>Function connect Returns a Connection object connected to the API Server (URL, ENTITY, LOGIN, PASSWORD are mandatory to connect the server, ROLE ans USER are optional)</p>
</dd>
</dl>

<h1><a class='u'
name="AUTHOR"
>AUTHOR</a></h1>

<p>Hexonet GmbH</p>

<p><a href="https://www.hexonet.net" class="podlinkurl"
>https://www.hexonet.net</a></p>

<h1><a class='u'
name="LICENSE"
>LICENSE</a></h1>

<p>MIT</p>

<!-- end doc -->

</body></html>