Skip to content

README.md

Latest commit

 

History

History
124 lines (83 loc) · 4 KB

README.md

File metadata and controls

124 lines (83 loc) · 4 KB

irisnet-java-client

Requirements

Building the API client library requires Maven to be installed.

Installation

To install the API client library to your local Maven repository, simply execute:

mvn install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn deploy

Refer to the official documentation for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
    <groupId>de.irisnet.java.client</groupId>
    <artifactId>irisnet-java-client</artifactId>
    <version>1.0.0</version>
    <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

compile "de.irisnet.java.client:irisnet-java-client:1.0.0"

Others

At first generate the JAR by executing:

mvn package

Then manually install the following JARs:

  • target/irisnet-java-client-1.0.0.jar
  • target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import de.irisnet.java.client.AIOperationsApi;

public class AIOperationsApiExample {

    public static void main(String[] args) {
        AIOperationsApi apiInstance = new AIOperationsApi();
        String licenseKey = null; // String | License obtained from irisnet.de shop.
        Integer detail = 1; // Integer | Sets the response details. Use 1 for minimum detail (better API performance), 2 for medium details and 3 for all details.
        File file = null; // File | 
        try {
            IrisNet result = apiInstance.checkImage(licenseKey, detail, file);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AIOperationsApi#checkImage");
            e.printStackTrace();
        }
    }
}

Documentation for API Endpoints

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

Class Method HTTP request Description
AIOperationsApi checkImage POST /v1/check-image/{licenseKey} Upload and check image against previously chosen configuration.
AIOperationsApi checkImageUrl POST /v1/check-url/{licenseKey} Check image url against previously chosen configuration.
AIOperationsApi downloadProcessed GET /v1/download/{filename} Get the resulting image file.
AIOperationsApi setINDefine POST /v1/set-definition Set definitions via pre-defined prototypes.
AIOperationsApi setINParams POST /v1/set-parameters Set the behaviour parameters for one object class.
LicenseKeyOperationsApi getAICost GET /v1/cost Get the cost of the previously set parameters. The cost of the configuration is subtracted from the license key during each check.
LicenseKeyOperationsApi getLicenseInfo GET /v1/info/{licenseKey} Get information from given license key.

Documentation for Models

Documentation for Authorization

All endpoints do not require authorization. Authentication schemes defined for the API:

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author