Harbor Compliance Orders API
Compliance service orders and fulfillment tracking.
Harbor Compliance Orders API is one of 6 APIs that Harbor Compliance publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 1 JSON Schema definition.
Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a getting-started guide, and 1 JSON Schema.
This API exposes 2 operations across 2 paths, and defines 4 schemas. It is described by OpenAPI 3.1.0, at version 1.0.
Requests are made against a single base URL, https://api.harborcompliance.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Harbor Compliance Orders API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as X-API-Key (apiKey).
By default, every request must be authenticated.
apiKey— API key for authenticating partner requests. Obtain your API key from the Harbor Compliance developer portal.
Paths & Operations 2
Across 2 paths, the API surfaces 2 operations — 2 GET. Each is listed below with its method, path, parameters, and response codes.
Compliance service orders and fulfillment tracking.
Schemas 4
The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are Order (11 properties), Document (5 properties), PaginationMeta (4 properties), Error (3 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Harbor Compliance 5
Other APIs Harbor Compliance publishes across the network.