Download the PHP package dvsa/mot-cpms-client without Composer
On this page you can find all versions of the php package dvsa/mot-cpms-client. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Informations about the package mot-cpms-client
CPMS Rest Client
Introduction
This a module designed to make restful API calls to CPMS backend API. It handles
- The generation of the required access token based on the scope
- Logging application and API calls to CPMS.
- Caching of access tokens when caching is set up and enabled.
Installation
The recommended way to install is through Composer.
Configuration
Modify config/autoload/cpms-client.global.php (or copy config/client-config.global.php.dist) as follows:
return [
'cpms_api' => [
'version' => 1,
'identity_provider' => '',
'enable_cache' => true, //Enable of caching of access tokens for reuse
'cache_storage' => 'filesystem',
'client_secret' => '',
'rest_client' => [
'options' => [
'domain' => ''
],
],
],
];
- : This is the version of CPMS API to target, currently on version 1
- : This is the service manager alias that should return an object which implements . This is mandatory. The following information is retrieved from the class
- : The ID issues by CPMS that uniquely identifies the Scheme e.g. OLCS
- : Hash value issued by CPMS
- : This is the OpenAM UUID of the logged-in user. It is the responsibility of the scheme to ensure that the data provided is valid as it would be logged against any action performed in CPMS for audit purposes.
- : This is the unique identifier for the customer on who is making the payment. In MoT this is the AE and in OLCS it would be the operator etc.
- : Enable caching of access tokens for reuse.
- : Zend cache storage alias which would be load using Zend's StorageCacheAbstractServiceFactory. The default is
- : The API domain to which all API calls will be sent.
To modify configuration for the MOT logger in client-config.global.php, please refer to the MOT Logger.
Controller Plugin
The module ships with a controller plugin which simplifies usage of the Rest Client. In your controller:
$client = $this->getCpmsRestClient();
Usage
Below a typical usage of the module.
-
Requesting access token to make a card payment . Note that this is just an example for usage. By default, the module does this for you behind the scenes.
$requiredScope = 'CARD'; $endPoint = '/api/token'; $client = $this->getCpmsRestClient(); $params = [ 'sales_reference' => 'your invoice number ', ...... ]; $response = $client->post($endPoint, $requiredScope, $params); -
Retrieving payment details and specifying required fields, page, depth etc . The client would generate the required access token for you, so you do not need to manually generate the access token.
$requiredScope = 'QUERY_TXN'; $endPoint = '/api/payment'; $params = [ 'page' => 1, 'sort' => 'id:desc', 'params' => [ 'depth' => -2, 'required_fields' => [ 'payment' => [ 'created_on', 'receipt_reference', 'scope', 'total_amount', 'payment_details', 'payment_status', 'customer_reference', 'created_by' ], 'paymentDetail' => [ 'product_reference', 'sales_reference', 'payment_reference', 'amount' ], 'scope' => [ 'code', 'name' ], 'paymentStatus' => [ 'code', 'name', ], ], ], ]; $payments = $this->getCpmsRestClient()->get($endPoint, $requiredScope, $params);-
Updating the status of a mandate
$requiredScope = 'DIRECT_DEBIT'; $endPoint = '/api/mandate/<mandate_reference>/status'; $params = [ 'status' => '<status code>' ]; $response = $this->getCpmsRestClient()->get($endPoint, $requiredScope, $params);
-
Specifying Required Fields
When querying CPMS for data e.g. payment details, it is recommended that you specify the fields you want returned in the request. If not specified, CMS would return the defaults fields which may change. The fields available are the column names as specified in the [database scheme] (https://wiki.i-env.net/display/EA/CPMS+Interface+Service+Definition#CPMSInterfaceServiceDefinition-DataModel).
Required field from main table e.g. Payment
$requiredFields = [
'created_on',
'receipt_reference',
'scope',
'total_amount',
'payment_details',
'payment_status',
'customer_reference',
'created_by'
]
Required fields from join tables e.g. PaymentDetails. Payment has a (one-to-many) relationship with PaymentDetails.
Note that the field names are underscore separated while the entity names are camel cases.
$requiredFields = [
'payment' => [
'created_on',
'receipt_reference',
'scope',
'total_amount',
'payment_details',
'payment_status',
'customer_reference',
'created_by'
],
'paymentDetail' => [
'product_reference',
'sales_reference',
'payment_reference',
'amount'
],
]
Contributing
Please refer to our Contribution Guide.
All versions of mot-cpms-client with dependencies
dvsa/mot-logger Version ^3.3.1
laminas/laminas-mvc Version ^3.3.0
laminas/laminas-cache Version ^3.12.0
laminas/laminas-filter Version ^2.13
laminas/laminas-cache-storage-adapter-apcu Version ^2.5.0
laminas/laminas-cache-storage-adapter-filesystem Version ^2.0
laminas/laminas-cache-storage-adapter-memory Version ^2.0
dvsa/mot-cpms-notifications Version ^3.0.2