Yodeck Layouts API
Multi-zone screen layouts that split a display into regions.
Yodeck Layouts API is one of 7 APIs that Yodeck publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Layouts. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes 5 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.0.3, at version 1.0.
Requests are made against a single base URL, https://app.yodeck.com/api/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Yodeck Layouts API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Authorization (tokenAuth).
By default, every request must be authenticated.
tokenAuth— Named, role-scoped API token generated in the Yodeck console (Account Settings Advanced Settings API Tokens). The token acts as a user with the permissions of…
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Multi-zone screen layouts that split a display into regions.
Schemas 3
The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Layout (3 properties), LayoutInput (2 properties), LayoutList (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 Yodeck 6
Other APIs Yodeck publishes across the network.