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

Thanx Rewards API

Retrieve, activate, finalize, and grant loyalty rewards.

Thanx Rewards API is one of 14 APIs that Thanx publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 50 JSON Schema definitions.

Tagged areas include Rewards. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, an API reference, authentication docs, best-practice docs, a JSON-LD context, and 50 JSON Schemas.

This API exposes 4 operations across 4 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version v4.0.

Requests are made against 4 base URLs: https://api.thanx.com, https://api.thanxsandbox.com, https://secure.api.thanx.com, https://secure.api.thanxsandbox.com.

4 operations 4 paths 3 schemas 2 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
v4.0
Base URL
https://api.thanx.com
Authentication
HTTP Bearer, API Key
Contact
License
Proprietary
Resource Areas
1

Authentication & Security 2

Thanx Rewards API declares 2 security schemes for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). An API key is passed in the header as X-ClientId (clientId). By default, every request must be authenticated.

  • bearerAuth — End-user access token acquired through Thanx SSO.
  • clientId — Client-specific identifier provided by Thanx.

Paths & Operations 4

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

Rewards 4

Retrieve, activate, finalize, and grant loyalty rewards.

GET
/rewards
Get Rewards
getRewards 5 params → 200
GET
/rewards/{id}
Get Reward
getReward 1 param → 200
POST
/rewards/{id}/activate
Activate Reward
activateReward 1 param → 200
POST
/rewards/{id}/finalize
Finalize Reward
finalizeReward 1 param → 200

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are Reward (16 properties), Pagination (3 properties), RewardEnvelope (1 property). Each schema is shown below with its type and property counts.

RewardEnvelope
object
1 property
Reward
object
16 properties
Pagination
object
3 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thanx-rewards-api-openapi.yml Raw ↑

Other APIs Thanx publishes across the network.

Thanx Account API
Thanx Auth API
Thanx Baskets API
Thanx Campaigns API
Thanx Cards API
Thanx Gift Cards API
Thanx Issuance Jobs API
Thanx Locations API
Thanx Metadata API
Thanx Points API
Thanx Purchases API
Thanx Subscribers API