Skip to main content

Working with DerScanner API

  1. DerScanner functionality is also available through the API. The API specification complies with the OpenAPI standard. The web interface is implemented using Swagger Codegen.

    To access the API:

    1. Go to Account > Access Data > Token & Password.
    2. Click API Specification.

    To make a request:

    1. Click on the desired request > Try it out.
    2. Specify the parameters.
    3. Click Execute.

    The corresponding cURL request and server response will be displayed below.

    Access to the specification in JSON format can be obtained via HTTP using a GET request to /app/api/v1/openapi.json with an API authorization token. For example:

    curl -H 'Authorization: Bearer <token>'
    <installation_address>/app/api/v1/openapi.json -o openapi.json</installation_address>

    As a result, the openapi.json file will be saved in the current directory and can be used by tools that generate libraries for accessing the JSON API.

    To generate a Java library for accessing the JSON API using OpenAPI Generator, you can use the following command:

    java -jar openapi-generator-cli.jar generate -g java -i openapi.json

    For more information about the OpenAPI standard and available code generation tools, refer to the official documentation: