Skip to content

Introduction

This API description is intended for software developers.

DPF provides two REST APIs:

  • Jobclient API:
    • Provided by seal-dpf-jobclient-api.
    • Creates and starts jobs, uploads input files and returns job results.
    • Default port: 4303
    • Path prefix: /rest/dpf/v1
  • Management API:
    • Provided by seal-dpf-management-api.
    • Lists, modifies and deletes jobs.
    • Default port: 4304
    • Path prefix: /rest/dpfmanagement/v1

For the endpoints of both APIs, refer to OpenAPI Specification.

The HTTP verbs used in both APIs have the following meanings:

  • GET requests return a resource or a list of resources.
  • POST requests create a resource or trigger an action, for example starting a job.
  • PUT requests change the status of a job.
  • DELETE requests remove one or more jobs.

As of DPF 4.3.0, access to the Jobclient API can be restricted via OpenID Connect (OIDC). By default, OIDC authentication is disabled. When enabled, every request requires a JSON Web Token (JWT). The requesting client is responsible for the user authentication and for presenting the JWT. For the configuration, refer to Restrict Access to the Jobclient API via OIDC.

Caution - OAuth 2.0 and OIDC not covered

OAuth 2.0 and the OIDC protocol usage is not part of this documentation. For more information, refer to the OAuth 2.0 RFC, the OpenID Connect specifications and the SEAL Interfaces for OIDC documentation.

Back to top