Download the PHP package dvsa/mot-cpms-client without Composer

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 when a logger alias is provided
• Caching of access tokens when caching is setup and enabled.

Installation

The recommended way to install is through [Composer][composer].

Configuration

3. Modify the configuration in the client-config.global.php file as follows:

    versionlogger_aliasidentity_providerCpmsClient\Authenticate\IdentityProviderInterfaceclient_idclient_secretuser_idcustomer_referenceenable_cachecache_storagefilesystemdomaincpms-clientcpms-clientPOSTGETPUT```
   
       $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.