Download the PHP package effectconnect/php-sdk without Composer

On this page you can find all versions of the php package effectconnect/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 effectconnect/php-sdk

Informations about the package php-sdk

EffectConnectSDK

SDK for EffectConnect API integration

This is a simple SDK to start connecting to our API.

So far this SDK only includes functionality and examples to create an order and inject a productfeed.

More information about the EffectConnect API: EffectConnect Docs

Getting started

Step 1: Installing the project

Including the project can be done via composer:

Or by downloading the source code and including the autoloader:

Step 2: Creating your API Keyset

For this step you'll need to go to your EffectConnect environment and create an API Keyset.

Make sure you assign all the required permissions to this keyset in order to use the calls you intend to.

Step 3: Basics

To use any API call you are required to create a Keychain and instantiate a Core object.

Step 4: Creating an Api Call object

At the moment, the following Call objects are available:

These objects can be obtained by calling their respective methods in the Core:

Step 5: Preparing your Api Call

All Api calls have their own requirements and will be validated. If invalid information is being passed to the call, an InvalidPayloadException will be thrown.

In this example we will read an order with identifier EC-ORDER-ID;

Now that we have our prepared ApiCall object, we can make the call to EffectConnect. At this stage no communication has taken place, the ApiCall::call() method is the first (and only) time you will connect with the EffectConnect API server.

Step 6: Checking the call

Now that we've made a call to EffectConnect, it's time to check whether everything has gone the way we intended to or if everything went the way of the dodo...

In case something went terribly wrong, the ApiCall::isSuccess() method will return false and more information about this failure should be found via the ApiCall::getErrors() method.

Step 7: Process your response

Yay, everything went exactly as we planned! Now it's time to do something with the response. The SDK contains objects for all the Response Containers.

This means you can access and process any information EffectConnect returns to you. In our example, an instance of OrderReadResponseContainer will be contained in our Response object.

Let's find out which identifiers are assigned to our EC-ORDER-ID!

All versions of php-sdk with dependencies

PHP Build Version
Package Version
Requires php Version >=5.5
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 effectconnect/php-sdk contains the following files

Loading the files please wait ....