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

Zinrelo Points API

Award, deduct, and manage member point balances.

Zinrelo Points API is one of 7 APIs that Zinrelo publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

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

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

Requests are made against a single base URL, https://api.zinrelo.com.

3 operations 3 paths 5 schemas 3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1.0
Base URL
https://api.zinrelo.com
Authentication
API Key, API Key
Contact
Resource Areas
1

Authentication & Security 2

Zinrelo Points API declares 2 security schemes for authenticating requests. An API key is passed in the header as partner-id (partnerId). An API key is passed in the header as api-key (apiKey). By default, every request must be authenticated.

  • partnerId — Your Zinrelo Partner ID, provisioned to your account.
  • apiKey — Your Zinrelo API key, provisioned to your account.

Paths & Operations 3

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

Points 3

Award, deduct, and manage member point balances.

POST
/v1/loyalty/award
Award points
awardPoints body → 200401
POST
/v1/loyalty/users/deduct
Deduct points
deductPoints body → 200401
POST
/v1/loyalty/purchase
Record a purchase
recordPurchase body → 200401

Schemas 5

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

Transaction
object
7 properties
DeductRequest
object
3 properties 2 required
Error
object
3 properties
AwardRequest
object
3 properties 2 required
PurchaseRequest
object
4 properties 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

zinrelo-points-api-openapi.yml Raw ↑

Other APIs Zinrelo publishes across the network.

Zinrelo Events API
Zinrelo Members API
Zinrelo Redemptions API
Zinrelo Rewards API
Zinrelo Tiers API
Zinrelo Transactions API