Download the PHP package upmind/hexonet-php-sdk without Composer

On this page you can find all versions of the php package upmind/hexonet-php-sdk. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Example code of upmind/hexonet-php-sdk

Informations about the package hexonet-php-sdk

php-sdk

semantic-release Build Status Packagist PHP from Packagist License: MIT PRs welcome

This module is a connector library for the insanely fast HEXONET Backend API. For further informations visit our homepage and do not hesitate to contact us.

Resources

Features

How to use this module in your project

We have also a demo app available showing how to integrate and use our SDK. See here.

Requirements

Download from packagist

This module is available on the PHP Package Registry.

Run composer require "hexonet/php-sdk:*" to get the latest version downloaded and added to composer.json. In your script simply use require 'vendor/autoload.php'; or require 'vendor/hexonet/php-sdk';

NOTE: The above will also set "hexonet/php-sdk": "*" as dependency entry in your composer.json. When running composer install this would always install the latest release version. This is dangerous for production systems as major version upgrades may come with breaking changes and are then incompatible with your app. For production systems we suggest to use a version dependent syntax, e.g. composer require "hexonet/php-sdk:v3.0.3". You can find the versions listed at packagist or at github in the release / tag overview.

Alternatives

Of course you could also using composer to install it from github or using the PHAR archives we offer for download in release overview, but the previous approach is the one we suggest. When using the .phar archive, please ensure to have the phar extension for PHP installed and loaded: php-phar

High Performance Proxy Setup

Long distances to our main data center in Germany may result in high network latencies. If you encounter such problems, we highly recommend to use this setup, as it uses persistent connections to our API server and the overhead for connection establishments is omitted.

Step 1: Required Apache2 packages / modules

At least Apache version 2.2.9 is required.

The following Apache2 modules must be installed and activated:

Step 2: Apache configuration

An example Apache configuration with binding to localhost:

After saving your configuration changes please restart the Apache webserver.

Step 3: Using this setup

So, what happens in code behind the scenes? We communicate with localhost (so our proxy setup) that passes the requests to the HEXONET API. Of course we can't activate this setup by default as it is based on Steps 1 and 2. Otherwise connecting to our API wouldn't work.

Just in case the above port or ip address can't be used, use function setURL instead to set a different URL / Port. http://127.0.0.1/api/call.cgi is the default URL for the High Performance Proxy Setup. e.g. $cl->setURL("http://127.0.0.1:8765/api/call.cgi"); would change the port. Configure that port also in the Apache Configuration (-> Step 2)!

Don't use https for that setup as it leads to slowing things down as of the https overhead of securing the connection. In this setup we just connect to localhost, so no direct outgoing network traffic using http. The apache configuration finally takes care passing it to https for the final communication to the HEXONET API.

Customize Logging / Outputs

When having the debug mode activated \HEXONET\Logger will be used for doing outputs. Of course it could be of interest for integrators to look for a way of getting this replaced by a custom mechanism like forwarding things to a 3rd-party software, logging into file or whatever.

NOTE: Find an example for a custom logger class implementation in src/CustomLogger.php. If you have questions, feel free to open a github issue.

Usage Examples

Please have an eye on our HEXONET Backend API documentation. Here you can find information on available Commands and their response data.

Session based API Communication

Available since version 4.x!

Save session config into PHP Session

If you're realizing your own frontend on top, you need a solution to keep the Backend API Session that the PHP-SDK wraps internally to be reusable in further page loads. This can be achieved by

and

Sessionless API Communication

Using array-based notation for bulk parameters in command [SINCE 5.2.0]

Use the below to improve code a bit:

instead of:

FYI

$cl - the APIClient Object - and $r - the Response Object - provide further useful Methods to access configure the connection and to access response data. Have an eye on the class documentation.

Contributing

Please read our development guide for details on our code of conduct, and the process for submitting pull requests to us.

Authors

See also the list of contributors who participated in this project.

License

This project is licensed under the MIT License - see the LICENSE file for details.

All versions of hexonet-php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=5.6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package upmind/hexonet-php-sdk contains the following files

Loading the files please wait ....