PHP SDK

Overview

PHP SDK is a library that simplifies work with Connect APIs and can be found at

• GitHub – available at https://github.com/cloudblue/connect-php-sdk
• PHP Composer – available at https://packagist.org/packages/apsconnect/connect-sdk

SDK allows easy and fast integration with various modules. It allows automating the processing of Assets Requests. Before using the library, please make sure you are familiar with the Assets Management Module first.

Key Features

The library can be consumed in your project in order to automate the fulfillment of requests. Once imported into your project, it will allow you to:

• Establish connectivity with the API using your api credentials
• List all requests, and filterthem:
  • by the particular Product
  • by the particular Status
• Retrieve detailed Request representation
• ModifyRequest’s properties in order to:
  • Inquiry for additional information
  • Store updated parameter values in the Request
• Change Request Status (Pending, Inquiring, Failed, Approved)
• Generate logs
• Collect debug logs in case of the failure

Your code may use any scheduler to execute, from a simple cron to a cloud scheduler like the ones available in the major cloud providers, like:

• Microsoft Azure Functions – https://docs.microsoft.com/en-us/azure/azure-functions/functions-create-scheduled-function
• Google Cloud Functions – https://cloud.google.com/solutions/reliable-task-scheduling-compute-engine
• Amazon AWS Lambdas – https://docs.aws.amazon.com/lambda/latest/dg/with-scheduled-events.html
• IBM Cloud Functions – https://www.ibm.com/cloud/functions

and others.

Additionally you may use the webhooks functionality from Connect to instantiate your solution,

Installation and Loading

PHP SDK is available

• For the installation via Composer (recommended)
• And also through Packagistusing semantic versioning
• in the form of a complete project template

Where Composer is the recommended way to installPHP SDK. All you need to do is to add this line to your composer.json file:

{
    "require": {
        "apsconnect/connect-sdk": "^19.0"
    }
}

or run the following command in your terminal:

$ composer require apsconnect/connect-sdk --no-dev --prefer-dist --classmap-authoritative

Please note that the vendor folder and the vendor/autoload.php script are automatically generated by the Composer.