Skip to content

Latest commit

 

History

History
102 lines (74 loc) · 4.35 KB

README.md

File metadata and controls

102 lines (74 loc) · 4.35 KB

Aurigma Customer's Canvas SDK - Rendering Service Client

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

This module is a PHP API client for Rendering 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-rendering-service-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-rendering-service-client.git"
    }
  ],
  "require": {
    "aurigma/php-rendering-service-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;
}
?>

API Endpoints

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

Class Method HTTP request Description
BuildInfoApi buildInfoGetInfo GET /api/rendering/v1/info Gets assembly build info
BuildInfoApi buildInfoHeadInfo HEAD /api/rendering/v1/info Gets assembly build info
RenderingJobsApi renderingJobsCreate POST /api/rendering/v1/jobs Creates new rendering job and starts execution
RenderingJobsApi renderingJobsDelete DELETE /api/rendering/v1/jobs/{id} Deletes specified rendering job
RenderingJobsApi renderingJobsDiscard POST /api/rendering/v1/jobs/{id}/discard Discards specified rendering job and prevents execution of a next task
RenderingJobsApi renderingJobsGet GET /api/rendering/v1/jobs/{id} Gets rendering job by id
RenderingJobsApi renderingJobsGetAll GET /api/rendering/v1/jobs Gets all entities relevant to specified query parameters
RenderingJobsApi renderingJobsRecover POST /api/rendering/v1/jobs/{id}/recover Recovers specified rendering job and continues execution

Models