aurigma / php-design-atoms-client
PHP API Client for Design Atoms API service of Customer's Canvas web-to-print system.
Requires
- php: ^7.4 || ^8.0
- ext-curl: *
- ext-json: *
- ext-mbstring: *
- guzzlehttp/guzzle: ^7.3
- guzzlehttp/psr7: ^1.7 || ^2.0
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.5
- phpunit/phpunit: ^8.0 || ^9.0
This package is auto-updated.
Last update: 2024-08-22 10:01:46 UTC
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/
Models
- BuildInfoModel
- ConvertColorsModel
- CreateDesignModel
- DesignInfo
- FontsMethodData
- GetImageSizeRequest
- GetShapeBoundsRequest
- ItemType
- MultiCallRequest
- MultiCallRequestItem
- NullAbleSize
- PointF
- ProblemDetails
- ProductProofFormat
- ProductProofInterpolationMode
- ProductProofRenderingConfig
- RectangleF
- RenderProductModel
- UpdateColorsRequest
- UpdateHandlerRequest
- UpdateImageHandlerRequest
- VdpDataModel