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

Kitchen Stories Personalization Admin API

The Personalization Admin API from Kitchen Stories — 4 operation(s) for personalization admin.

Kitchen Stories Personalization Admin API is one of 37 APIs that Kitchen Stories publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Personalization Admin. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 6 operations across 4 paths, and defines 5 schemas. It is described by OpenAPI 3.0.0, at version 3.

Requests are made against 3 base URLs: https://api.kitchenstories.io/api, https://api.dev.kitchenstories.io/api, http://localhost:8000/api.

6 operations 4 paths 5 schemas 2 DELETE2 POST2 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.0
API Version
3
Base URL
https://api.kitchenstories.io/api
Authentication
HTTP Bearer, API Key
License
Resource Areas
1

Authentication & Security 2

Kitchen Stories Personalization Admin API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearerAuth). An API key is passed in the header as X-Ultron-User (ApiKeyAuth). By default, every request must be authenticated.

Paths & Operations 6

Across 4 paths, the API surfaces 6 operations — 2 DELETE, 2 POST, 2 PUT. Each is listed below with its method, path, parameters, and response codes.

Personalization Admin 6
POST
/personalization/options/
Insert a new personalization option
personalizationoptions-post body → 200403
PUT
/personalization/options/{uuid}/
Globally update an option information
personalizationoptions-put-by-uuid 1 param body → 200404403
DELETE
/personalization/options/{uuid}/
Globally delete an option
personalizationoptions-delete-by-uuid 1 param → 200404403
POST
/personalization/options/{uuid}/values/
Create a new value for an option
personalizationoptions-values-post 1 param body → 200404403
PUT
/personalization/options/{option-uuid}/values/{value-uuid}/
Globally update a value for an option
personalizationoptions-values-put-by-uuid 2 params body → 200404403
DELETE
/personalization/options/{option-uuid}/values/{value-uuid}/
Globally delete a value for an option
personalizationoptions-values-delete-by-uuid 2 params → 200404403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are personalization_option_value (8 properties), personalization_option_value_body (8 properties), personalization_option_body (6 properties), personalization_option_translation_body (3 properties). Each schema is shown below with its type and property counts.

personalization_option_body
object
6 properties 3 required
personalization_option_translation_body
object
3 properties 3 required
form_response
object
1 property 1 required
personalization_option_value_body
object
8 properties 1 required
personalization_option_value
object
8 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kitchenstories-personalization-admin-api-openapi.yml Raw ↑

Other APIs Kitchen Stories publishes across the network.

Kitchen Stories Articles Admin API
Kitchen Stories Articles API
Kitchen Stories Authentication API
Kitchen Stories Categories Admin API
Kitchen Stories Categories API
Kitchen Stories Content Collections Admin API
Kitchen Stories Content Collections API
Kitchen Stories Feed API
Kitchen Stories Indexer API
Kitchen Stories Ingredients API
Kitchen Stories Other API
Kitchen Stories Personalization API