Download the PHP package apsconnect/connect-sdk without Composer

Connect PHP SDK

Getting Started

Connect PHP SDK allows an easy and fast integration with CloudBlue Connect Fulfillment and Usage APIs with PHP-based integrations. This SDK enables you to automate fulfillment of orders for your products and report usage data for them.

Before using the library, please first to go through the documentation in the Connect knowledge base, which could be used as a source of information on the rest APIs used by this SDK.

Class Features

This library can be utilized in your project for the automation of the fulfillment logic as well as usage reporting. This class, once imported into your project, will enable you to:

• Establish connectivity to Connect APIs
• List all requests and apply filters like
  • Filter requests by Product
  • Filter requests by Status
  • Filter requests by Asset
  • etc.
• Process each request and obtain full details of the request
• Modify parameters of a request in order to:
  • Inquire for changes
  • Store information into the fulfillment request
• Change the status of the requests from it's initial pending state to either inquiring, failed or approved.
• Generate and upload usage files to report usage for active contracts and listings
• Process usage file status changes
• Work with Notes for requests
• Generate logs
• Collect debug logs in case of failure

Your code may use any scheduler to execute, from a simple cron to a cloud scheduler like the ones available in Azure, Google, Amazon or other cloud platforms.

Installation & loading

Connect PHP SDK is available through Packagist (using semantic versioning), and installation via the Composer is the recommended way to install the Connect PHP SDK. Just add these lines to your composer.json file:

or run

Note that the vendor folder and the vendor/autoload.php script are generated by Composer

A Simple Example of the fulfillment

This example demonstrates a script that will retrieve all requests in the status pending and process them based on their type (purchase, change, cancel, suspend or resume)

A Simple Example of reporting Usage Files

A Simple Example of automating workflow of Usage Files

A simple Example of automating workflow for Tier Account Requests

Client class

Starting with the Connect PHP SDK version 17 the Client class has been introduced. This class allows running multiple operations in Connect like get the list of requests, configurations, etc. Client class may be instantiated from any application to obtain information needed to run an operation, like, for example, get the Asset information in the context of an action. Client will provide access to:

• Directory
• Fulfillment
• Tier Configurations

Creating a Client

This is an example to create a client:

Connect Client usage examples:

• Retrieve Tier Configurations

• Retrieve Tier Configuration

• Retrieve list of Assets

• Retrieve an Asset

• Get Products Information

• Get Product Information

• List all requests

In case of no filter, pending ones are returned

• Get Concrete request

• List all Tier Accoounts

• Get concrete Tier Account

• List tier account requests

• List Asset Subscriptions

• Get Subscription Asset

• Get Billing Subscription Requests

• Get concrete Billing request