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 protocol API

access to submission protocol

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

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

This API exposes 1 operation across 1 path, and defines 15 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 15 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 protocol 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.

protocol 1

access to submission protocol

GET
/v2/submissions/protocoldeprecated
Delivers all submissions protocol for a provider
getSubmissionsProtocol 7 params → 200400401500

Schemas 15

The contract defines 15 schemas that model the data the API accepts and returns. The most detailed are UnexpectedError (6 properties), Paging (6 properties), ProtocolItem (4 properties), SubmissionProtocol (2 properties). Each schema is shown below with its type and property counts.

SubmissionProtocolRef
object
SubmissionProtocolItem
object
2 properties
EmbeddedSubmissionProtocol
object
1 property
UnexpectedError
object
6 properties 5 required
Paging
object
6 properties
SubmissionProtocolRefItem
object
SubmissionProtocol
object
2 properties
SubmissionRef
object
ProtocolItem
object
4 properties
BadRequest
ClientError
object
1 required
ProtocolItemType
string
open ended enum contains possible protocol item types, possible values are (DOCUMENT, DATA, STATUS, NEWSUBMISSION)
Cursor
object
2 properties
ResourceRef
object
1 property 1 required
Unauthorized

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

interhyp-protocol-api-openapi.yml Raw ↑

Other APIs Interhyp publishes across the network.

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