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

Hyperline Products API

The Products API from Hyperline — 3 operation(s) for products.

Hyperline Products API is one of 7 APIs that Hyperline publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Products. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 6 operations across 3 paths, and defines 1 schema. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.hyperline.co/v1, https://sandbox.api.hyperline.co/v1.

6 operations 3 paths 1 schemas 3 GET1 PATCH2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
1.0
Base URL
https://api.hyperline.co/v1
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

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

  • bearerAuth — Authenticate with your Hyperline API key passed as a bearer token in the Authorization header - Authorization: Bearer .

Paths & Operations 6

Across 3 paths, the API surfaces 6 operations — 3 GET, 1 PATCH, 2 POST. Each is listed below with its method, path, parameters, and response codes.

Products 6
GET
/products
List products
listProducts → 200
POST
/products
Create a product
createProduct body → 201
GET
/products/{id}
Retrieve a product
getProduct 1 param → 200
PATCH
/products/{id}
Update a product
updateProduct 1 param → 200
GET
/price-books
List price books
listPriceBooks → 200
POST
/price-books
Create a price book
createPriceBook → 201

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. The most detailed is Product (4 properties). Each schema is shown below with its type and property counts.

Product
object
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hyperline-products-api-openapi.yml Raw ↑

Other APIs Hyperline publishes across the network.

Hyperline Billable Events API
Hyperline Customers API
Hyperline Invoices API
Hyperline Payments API
Hyperline Subscriptions API
Hyperline Webhooks API