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

Yotpo Authentication API

OAuth token exchange for app key + secret.

Yotpo Authentication API is one of 4 APIs that Yotpo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

This API exposes 1 operation across 1 path, and defines 2 schemas. It is described by OpenAPI 3.0.1, at version 1.0.

Requests are made against 2 base URLs: https://api.yotpo.com, https://loyalty.yotpo.com/api/v2.

1 operations 1 paths 2 schemas 1 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.yotpo.com
Authentication
API Key, API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 3

Yotpo Authentication API declares 3 security schemes for authenticating requests. An API key is passed in the query as utoken (UToken). An API key is passed in the header as x-guid (LoyaltyGuid). An API key is passed in the header as x-api-key (LoyaltyApiKey).

  • UToken — OAuth access token obtained from POST /oauth/token.
  • LoyaltyGuid — Loyalty & Referrals account GUID.
  • LoyaltyApiKey — Loyalty & Referrals API key.

Paths & Operations 1

Across 1 path, the API surfaces 1 operation — 1 POST. Each is listed below with its method, path, parameters, and response codes.

Authentication 1

OAuth token exchange for app key + secret.

POST
/oauth/token
Generate an OAuth access token (utoken).
createAccessToken body → 200

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are TokenRequest (3 properties), TokenResponse (2 properties). Each schema is shown below with its type and property counts.

TokenResponse
object
2 properties
TokenRequest
object
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

yotpo-authentication-api-openapi.yml Raw ↑

Other APIs Yotpo publishes across the network.

Yotpo Loyalty API
Yotpo Reviews API
Yotpo Subscriptions API