HitchPin rendering API
The rendering API from HitchPin — 3 operation(s) for rendering.
HitchPin rendering API is one of 3 APIs that HitchPin publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include rendering. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 3 operations across 3 paths, and defines 6 schemas. It is described by OpenAPI 3.1.1, at version 2.0.0.
Requests are made against 5 base URLs: https://localhost, https://apiv2.sandbox.hitchpin.com, https://apiv2.staging.hitchpin.com, https://apiv2.demo.hitchpin.com, https://apiv2.hitchpin.com.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
HitchPin rendering API declares
2 security schemes
for authenticating requests.
An API key is passed in the cookie as sessionid (cookieAuth).
An API key is passed in the header as Authorization (tokenAuth).
tokenAuth— Token-based authentication with required prefix "Token"
Paths & Operations 3
Across 3 paths, the API surfaces 3 operations — 2 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are ShortenUrlRequest (8 properties), RenderReceiptRequest (4 properties), CreateRenderedReceiptUrlRequest (2 properties), ShortenUrlResponse (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HitchPin 2
Other APIs HitchPin publishes across the network.