README

======================================================

This module is an PHP API client for Design Atoms API service which is a part of Customer's Canvas web-to-print system. It is supposed that you are familiar with its services and understand how to use its APIs. To learn more about Customer's Canvas and its services, refer the Getting Started section of its documentation.

Pre-requisites

To be able to use this package, you need to meet the following requirements:

You must have an account at Customer's Canvas.

For other platforms, see the Backend services article in Customer's Canvas documentation.

Installation

composer require aurigma/php-design-atoms-client

Requirements

PHP 7.2 and later.

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/aurigma/php-design-atoms-client.git"
    }
  ],
  "require": {
    "aurigma/php-design-atoms-client": "*@dev"
  }
}

Then run composer install

Getting Started

Please follow the installation procedure.

Receive an access token through your backend as explained in the documentation and deliver it to your app.

Then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');




$apiInstance = new OpenAPI\Client\Api\BuildInfoApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client()
);

try {
    $result = $apiInstance->buildInfoGetInfo();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling BuildInfoApi->buildInfoGetInfo: ', $e->getMessage(), PHP_EOL;
}
?>

Tests

To run the tests, use:

composer install
vendor/bin/phpunit

Author

Aurigma Inc info@aurigma.com (https://customerscanvas.com)

API Endpoints

All URIs are relative to https://dm-designatomsapi.azurewebsites.net/

Class	Method	HTTP request	Description
BuildInfoApi	buildInfoGetInfo	GET /api/atoms/v1/info	Gets assembly build info
BuildInfoApi	buildInfoHeadInfo	HEAD /api/atoms/v1/info	Gets assembly build info
DesignAtomsCompatibilityApi	designAtomsCompatibilityCssFonts	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/cssfonts
DesignAtomsCompatibilityApi	designAtomsCompatibilityFonts	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/fonts/{psName}
DesignAtomsCompatibilityApi	designAtomsCompatibilityGetCssFont	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetCssFont
DesignAtomsCompatibilityApi	designAtomsCompatibilityGetImageSize	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetImageSize
DesignAtomsCompatibilityApi	designAtomsCompatibilityGetLicense	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/license
DesignAtomsCompatibilityApi	designAtomsCompatibilityGetShapeBounds	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetShapeBounds
DesignAtomsCompatibilityApi	designAtomsCompatibilityGetWatermarkItems	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/GetWatermarkItems
DesignAtomsCompatibilityApi	designAtomsCompatibilityImg	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/img
DesignAtomsCompatibilityApi	designAtomsCompatibilityPth	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/pth
DesignAtomsCompatibilityApi	designAtomsCompatibilityResource	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/resource
DesignAtomsCompatibilityApi	designAtomsCompatibilitySvg	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/svg
DesignAtomsCompatibilityApi	designAtomsCompatibilityTxt	GET /api/atoms/v1/tenants/{tenantId}/api/ccviewer/txt
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateArchedTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/api/ccviewer/UpdateArchedTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateAutoScaledTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateAutoScaledTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateBarcodeItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBarcodeItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateBoundedTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateBoundedTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateByColorData	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByColorData
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateByMultiCallRequest	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateByMultiCallRequest
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateCurvedTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateCurvedTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateImageItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateImageItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdatePathBoundedTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePathBoundedTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdatePlainTextItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdatePlainTextItemHandler
DesignAtomsCompatibilityApi	designAtomsCompatibilityUpdateShapeItemHandler	POST /api/atoms/v1/tenants/{tenantId}/api/ccviewer/UpdateShapeItemHandler
DesignAtomsServiceApi	designAtomsServiceConvertColors	POST /api/atoms/v1/colorConverter	Converts colors
DesignAtomsServiceApi	designAtomsServiceCreateDesign	POST /api/atoms/v1/designs	Creates new design file with specified parameters and saves it in storage.
DesignAtomsServiceApi	designAtomsServiceCreateItem	POST /api/atoms/v1/itemCreator	Creates product item
DesignAtomsServiceApi	designAtomsServiceDeleteDataSchema	DELETE /api/atoms/v1/designs/{id}/schema	Deletes data schema from design file and updates design in storage.
DesignAtomsServiceApi	designAtomsServiceDeleteVdpData	DELETE /api/atoms/v1/designs/{id}/vdpData	Deletes variable data printing inforamtion from design file and updates design in storage.
DesignAtomsServiceApi	designAtomsServiceLoadDataSchema	GET /api/atoms/v1/designs/{id}/schema	Loads data schema from design file taken from storage
DesignAtomsServiceApi	designAtomsServiceLoadProduct	GET /api/atoms/v1/designs/{id}/model	Loads product from design file taken from storage
DesignAtomsServiceApi	designAtomsServiceLoadVdpData	GET /api/atoms/v1/designs/{id}/vdpData	Loads variable data printing information from design file taken from storage
DesignAtomsServiceApi	designAtomsServiceRenderProduct	POST /api/atoms/v1/renderer	Render product proof image with specified parameters.
DesignAtomsServiceApi	designAtomsServiceSaveDataSchema	PUT /api/atoms/v1/designs/{id}/schema	Saves data schema to design file and updates design in storage.
DesignAtomsServiceApi	designAtomsServiceSaveProduct	PUT /api/atoms/v1/designs/{id}/model	Saves product to design file and updates design in storage.
DesignAtomsServiceApi	designAtomsServiceSaveVdpData	PUT /api/atoms/v1/designs/{id}/vdpData	Saves variable data printing information to design file and updates design in storage.
DesignAtomsViewerApi	designAtomsViewerCssFonts	POST /api/atoms/v1/ccviewer/cssfonts
DesignAtomsViewerApi	designAtomsViewerFonts	GET /api/atoms/v1/ccviewer/fonts/{psName}
DesignAtomsViewerApi	designAtomsViewerGetCssFont	GET /api/atoms/v1/ccviewer/GetCssFont
DesignAtomsViewerApi	designAtomsViewerGetImageSize	POST /api/atoms/v1/ccviewer/GetImageSize
DesignAtomsViewerApi	designAtomsViewerGetLicense	GET /api/atoms/v1/ccviewer/license
DesignAtomsViewerApi	designAtomsViewerGetShapeBounds	POST /api/atoms/v1/ccviewer/GetShapeBounds
DesignAtomsViewerApi	designAtomsViewerGetWatermarkItems	POST /api/atoms/v1/ccviewer/GetWatermarkItems
DesignAtomsViewerApi	designAtomsViewerImg	GET /api/atoms/v1/ccviewer/img
DesignAtomsViewerApi	designAtomsViewerPth	GET /api/atoms/v1/ccviewer/pth
DesignAtomsViewerApi	designAtomsViewerResource	GET /api/atoms/v1/ccviewer/resource
DesignAtomsViewerApi	designAtomsViewerSvg	GET /api/atoms/v1/ccviewer/svg
DesignAtomsViewerApi	designAtomsViewerTxt	GET /api/atoms/v1/ccviewer/txt
DesignAtomsViewerApi	designAtomsViewerUpdateArchedTextItemHandler	POST /api/atoms/v1/ccviewer/api/ccviewer/UpdateArchedTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateAutoScaledTextItemHandler	POST /api/atoms/v1/ccviewer/UpdateAutoScaledTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateBarcodeItemHandler	POST /api/atoms/v1/ccviewer/UpdateBarcodeItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateBoundedTextItemHandler	POST /api/atoms/v1/ccviewer/UpdateBoundedTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateByColorData	POST /api/atoms/v1/ccviewer/UpdateByColorData
DesignAtomsViewerApi	designAtomsViewerUpdateByMultiCallRequest	POST /api/atoms/v1/ccviewer/UpdateByMultiCallRequest
DesignAtomsViewerApi	designAtomsViewerUpdateCurvedTextItemHandler	POST /api/atoms/v1/ccviewer/UpdateCurvedTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateImageItemHandler	POST /api/atoms/v1/ccviewer/UpdateImageItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdatePathBoundedTextItemHandler	POST /api/atoms/v1/ccviewer/UpdatePathBoundedTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdatePlainTextItemHandler	POST /api/atoms/v1/ccviewer/UpdatePlainTextItemHandler
DesignAtomsViewerApi	designAtomsViewerUpdateShapeItemHandler	POST /api/atoms/v1/ccviewer/UpdateShapeItemHandler

aurigma / php-design-atoms-client

Maintainers

Details