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

Zaius Identifiers API

The Identifiers API from Zaius — 3 operation(s) for identifiers.

Zaius Identifiers API is one of 17 APIs that Zaius publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Identifiers. The published artifact set on APIs.io includes an OpenAPI specification.

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

Requests are made against 3 base URLs: https://api.us1.odp.optimizely.com/v3, https://api.eu1.odp.optimizely.com/v3, https://api.au1.odp.optimizely.com/v3.

3 operations 3 paths 5 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v3
Base URL
https://api.us1.odp.optimizely.com/v3
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Zaius Identifiers API declares 1 security scheme for authenticating requests. An API key is passed in the header as x-api-key (x-api-key). By default, every request must be authenticated.

Paths & Operations 3

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

Identifiers 3
POST
/schema/identifiers
Create identifier
create-identifier body → 201400403
POST
/identifiers
Update identifier metadata
update-identifier-metadata body → 202400403
GET
/identifiers/{field_name}
Get identifier metadata
get-identifier-metadata 2 params → 200403

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are IdenfitierMetadata (5 properties), Identifier (5 properties), Error (4 properties), UpdateIdentifier (3 properties). Each schema is shown below with its type and property counts.

Error
object
4 properties
Identifier
object
5 properties 3 required
IdentifierCreated
object
2 properties
IdenfitierMetadata
object
5 properties
UpdateIdentifier
object
3 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zaius-identifiers-api-openapi.yml Raw ↑

Other APIs Zaius publishes across the network.

Zaius Compliance API
Zaius Consent API
Zaius Consent (Legacy) API
Zaius Customers API
Zaius Events API
Zaius Exports API
Zaius Fields schema API
Zaius Lists API
Zaius Object schema API
Zaius Objects API
Zaius Orders API
Zaius Products API