deeparteffects/sdk-php

Deep Art Effects SDK for PHP

1.1 2020-04-11 19:51 UTC

Requires

• php: >=5.4
• ext-curl: *
• ext-json: *
• ext-mbstring: *
• aws/aws-sdk-php: ^3.28

Requires (Dev)

• friendsofphp/php-cs-fixer: ~1.12
• phpunit/phpunit: ~4.8
• satooshi/php-coveralls: ~1.0
• squizlabs/php_codesniffer: ~2.6

proprietary

• Deep Art Effects GmbH

• php
• api
• sdk
• deeparteffects

README

Use this SDK to access the Deep Art Effects API with PHP.

Requirements

PHP 5.4.0 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "git",
      "url": "https://github.com/deeparteffects/sdk-php.git"
    }
  ],
  "require": {
    "deeparteffects/sdk-php": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/sdk-php/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php

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

$api_key = '--Your API Key--';
$access_key = '--Your ACCESS Key--';
$secret_key = '--Your SECRET KEY--';

$api_instance = new \Deeparteffects\Client\Api\DefaultApi();
$api_instance->setApiKey($api_key);
$api_instance->setApiAccessKey($access_key);
$api_instance->setApiSecretKey($secret_key);

try {
    $styles = $api_instance->stylesGet();

    foreach ($styles as $style) {
        print_r($style->getTitle());
    }

} catch (Exception $e) {
    echo 'Exception when calling DefaultApi->stylesGet: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://api.deeparteffects.com/v1

Class	Method	HTTP request	Description
DefaultApi	resultGet	GET /result
DefaultApi	stylesGet	GET /styles
DefaultApi	uploadPost	POST /upload

Documentation For Models

• Error
• ModelEmpty
• Result
• Style
• Styles
• UploadRequest
• UploadResponse

Documentation For Authorization

api_key

• Type: API key
• API key parameter name: x-api-key
• Location: HTTP header

Author

Deep Art Effects GmbH