Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Interhyp commands API

provides endpoints to access to commands sent to the submission API

Interhyp commands API is one of 8 APIs that Interhyp publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include commands. The published artifact set on APIs.io includes an OpenAPI specification.

This API exposes 1 operation across 1 path, and defines 5 schemas. It is described by OpenAPI 3.0.2, at version 2.0.0.

Requests are made against 2 base URLs: https://api-test.interhyp.de/submission, https://api.interhyp.de/submission.

1 operations 1 paths 5 schemas 1 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.2
API Version
2.0.0
Base URL
https://api.interhyp.de/submission/v2
Authentication
HTTP Bearer
License
Interhyp AG
Resource Areas
1

Authentication & Security 1

Interhyp commands API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (BearerAuth). By default, every request must be authenticated.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 GET. Each is listed below with its method, path, parameters, and response codes.

commands 1

provides endpoints to access to commands sent to the submission API

GET
/commands/{commandId}
Get an existing command
getCommandsById 1 param → 200400401404500

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are RFC7807Problem (8 properties), Command (5 properties), Violation (2 properties), OAuthProblem (2 properties). Each schema is shown below with its type and property counts.

CommandError
object
2 properties 1 required
RFC7807Problem
object
DE: Angaben zum zurueckgegebenen Fehler. EN: Holds information on the returned error.
8 properties 5 required
OAuthProblem
object
Error while Authentication
2 properties 2 required
Violation
object
DE: Ein Verstoss gegen die Schnittstellenspezifikation. EN: A violation against the API schema.
2 properties
Command
object
5 properties 4 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interhyp-commands-api-openapi.yml Raw ↑

Other APIs Interhyp publishes across the network.

Interhyp documents API
Interhyp financing-application API
Interhyp info API
Interhyp logbook API
Interhyp pre-submission-checks API
Interhyp protocol API
Interhyp submissions API