Skip to content

MiscellaneousOperationsApi.md

Latest commit

 

History

History
169 lines (109 loc) · 4.47 KB

MiscellaneousOperationsApi.md

File metadata and controls

169 lines (109 loc) · 4.47 KB

Irisnet\API\Client\MiscellaneousOperationsApi

All URIs are relative to https://api.irisnet.de

Method HTTP request Description
downloadProcessed GET /v1/download/{filename} Get the resulting media file.
getAICost GET /v1/cost Get the cost per image check of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.
getLicenseInfo GET /v1/info/{licenseKey} Get information from given license key.

downloadProcessed

\SplFileObject downloadProcessed($filename)

Get the resulting media file.

Example

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


$apiInstance = new Irisnet\API\Client\Api\MiscellaneousOperationsApi(
    // 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()
);
$filename = 'filename_example'; // string | 

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

Parameters

Name Type Description Notes
filename string

Return type

\SplFileObject

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/octet-stream

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getAICost

int getAICost()

Get the cost per image check of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.

Example

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


$apiInstance = new Irisnet\API\Client\Api\MiscellaneousOperationsApi(
    // 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->getAICost();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling MiscellaneousOperationsApi->getAICost: ', $e->getMessage(), PHP_EOL;
}
?>

Parameters

This endpoint does not need any parameter.

Return type

int

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: /

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getLicenseInfo

\Irisnet\API\Client\Model\LicenseInfo getLicenseInfo($licenseKey)

Get information from given license key.

Example

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


$apiInstance = new Irisnet\API\Client\Api\MiscellaneousOperationsApi(
    // 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()
);
$licenseKey = 'licenseKey_example'; // string | License obtained from the https://www.irisnet.de/prices shop.

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

Parameters

Name Type Description Notes
licenseKey string License obtained from the https://www.irisnet.de/prices shop.

Return type

\Irisnet\API\Client\Model\LicenseInfo

Authorization

No authorization required

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/xml, application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]