How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BYBE API

The BYBE Retail API, version 1. A REST/JSON API over BYBE's records of manufacturers, rebate offers and products, plus the write surface that clips offers for consumers, validates redemptions against purchases, and disburses consumer payouts. 16 operations across 7 tags, authenticated with HTTP Basic (API key as username, API secret as password). US only - the state filter on offers and stores is how BYBE's state-by-state alcohol compliance boundary is expressed in the contract.

BYBE API is published by BYBE on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Rebates, Promotions, Offers, Redemptions, and Disbursements. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and API documentation.

This API exposes 16 operations across 14 paths, organized into 7 resource areas, and defines 1 schema. It is described by OpenAPI 3.0.1, at version v1.

Requests are made against the base URL https://api.bybe.io.

16 operations 14 paths 1 schemas 13 GET3 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.1
API Version
v1
Base URL
https://api.bybe.io
Authentication
HTTP Basic
Resource Areas
7

Authentication & Security 1

BYBE API declares 1 security scheme for authenticating requests. It accepts HTTP basic authentication (basic_auth).

  • basic_auth — Use your API key (token) and your API secret for username and password respectively. You can get these credentials, or generate new ones, on your developer pag…

Paths & Operations 16

Across 14 paths, the API surfaces 16 operations — 13 GET, 3 POST. They span 7 resource areas: Clips, Consumers, Manufacturers, Offers, Products, Redemptions, Stores. Each is listed below with its method, path, parameters, and response codes.

Clips 3

A clip represents a consumer's intent to redeem an offer.

GET
/v1/clips
list clips
4 params → 200
POST
/v1/clips
create a clip
body → 201303409422
GET
/v1/clips/{id}
show clip
1 param → 200
Consumers 2

A consumer purchases products and clips/redeems offers.

POST
/v1/consumers
create a consumer
body → 200
GET
/v1/consumers/{retailer_identifier}
show consumer
1 param → 200
Manufacturers 2

A manufacturer represents a company or organization that produces alcoholic beverages.

GET
/v1/manufacturers
list manufacturers
2 params → 200
GET
/v1/manufacturers/{id}
show a manufacturer
1 param → 200
Offers 2

An offer is created and funded by a manufacturer (brand).

GET
/v1/offers
list offers
6 params → 200
GET
/v1/offers/{id}
get details for a single offer
1 param → 200
Products 2

A product is produced by a manufacturer and is featured in offers.

GET
/v1/products
list products
6 params → 200
GET
/v1/products/{id}
show a single product
1 param → 200
Redemptions 3

Redemptions are created to disburse money to a consumer for their specific purchases.

GET
/v1/redemption_disbursements
list redemption disbursements
3 params → 200
POST
/v1/redemption_disbursements
create a redemption disbursement
1 param body → 201422
GET
/v1/redemption_disbursements/{id}
show a redemption disbursement
1 param → 200
Stores 2

A store represents a specific retail location of a retailer.

GET
/v1/stores
list stores
1 param → 200
GET
/v1/stores/{id}
show store details
3 params → 200

Schemas 1

The contract defines 1 schema that model the data the API accepts and returns. Each schema is shown below with its type and property counts.

state_string_enum
string

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

bybe-api-openapi-original.yml Raw ↑
Where this information came from

This is an independent, third-party profile of BYBE API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.