IrisnetPHPClient

Artificial Intelligence (AI) for image- and video-processing in realtime. This is an interactive documentation meant to give a place were you can quickly look up the endpoints and their schemas, while also giving you the option to try things out yourself.

Listed below you'll see the available endpoints of the API that can be expanded by clicking on it. Each expanded endpoint lists the request parameter (if available) and the request body (if available). The request body can list some example bodies and the schema, explaining each model in detail. Additionally you'll find a 'Try it out' button where you can type in your custom parameters and custom body and execute that against the API. The responses section in the expanded endpoint lists the possible responses with their corresponding status codes. If you've executed an API call it will also show you the response from the server.

Underneath the endpoints you'll find the model schemas. These are the models used for the requests and responses.By clicking on the right arrow you can expand the model and it will show you a description of the model and the model parameters. For nested models you can keep clicking the right arrow to reveal further details on it.

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: v1
• Package version: 2.2.0
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 5.5 and later

Installation & Usage

Composer

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

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/GIT_USER_ID/GIT_REPO_ID.git"
    }
  ],
  "require": {
    "GIT_USER_ID/GIT_REPO_ID": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/IrisnetPHPClient/vendor/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');



$apiInstance = new Irisnet\API\Client\Api\EndpointsForAIChecksApi(
    // 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 irisnet.de shop.
$detail = 1; // int | Sets the response details.  * _1_ - The response body informs you if the image is ok or not ok (better API performance) * _2_ - In addition the response body lists all broken rules. * _3_ - In addition to the first two options, this will show all objects with positional information.
$file = "/path/to/file.txt"; // \SplFileObject | 

try {
    $result = $apiInstance->checkImage($licenseKey, $detail, $file);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling EndpointsForAIChecksApi->checkImage: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

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

Class	Method	HTTP request	Description
EndpointsForAIChecksApi	checkImage	POST /v1/check-image/{licenseKey}	Upload and check image against previously chosen configuration.
EndpointsForAIChecksApi	checkImageUrl	POST /v1/check-url/{licenseKey}	Check image url against previously chosen configuration.
EndpointsToSetupTheAIApi	setINDefine	POST /v1/set-definition	Set definitions via pre-defined prototypes.
EndpointsToSetupTheAIApi	setINParams	POST /v1/set-parameters	Set the behaviour parameters for one object class.
MiscellaneousOperationsApi	downloadProcessed	GET /v1/download/{filename}	Get the resulting media file.
MiscellaneousOperationsApi	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.
MiscellaneousOperationsApi	getLicenseInfo	GET /v1/info/{licenseKey}	Get information from given license key.

Documentation For Models

• INDefault
• INDefineAI
• INError
• INImage
• INObject
• INParam
• INParams
• INRule
• InlineObject
• IrisNet
• LicenseInfo

Documentation For Authorization

All endpoints do not require authorization.

Author