Herald Distributors API
The Distributors API from Herald — 1 operation(s) for distributors.
Herald Distributors API is one of 10 APIs that Herald publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Distributors. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 2 operations across 1 path, and defines 3 schemas. It is described by OpenAPI 3.0.1, at version 1.0.
Requests are made against a single base URL, https://api.heraldapi.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Herald Distributors API declares
1 security scheme
for authenticating requests.
It accepts HTTP bearer tokens (JWT) (bearerAuth).
By default, every request must be authenticated.
bearerAuth— Send an API key or an access token from /auth/token in the Authorization header as Bearer . Access tokens are obtained via the OAuth2 client-credentials grant…
Paths & Operations 2
Across 1 path, the API surfaces 2 operations — 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Distributor (3 properties), Error (3 properties), DistributorCreateRequest (2 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 Herald 9
Other APIs Herald publishes across the network.