# Cheerfy

> Cheerfy is a customer-engagement and digital-experience platform for restaurants and hospitality
> brands, combining CRM and loyalty, online ordering, pay-at-table, self-service kiosks and a
> multi-brand marketplace. It centralizes customer data from POS, bookings, Wi-Fi and payment
> systems, then drives automated SMS, email and push marketing, branded loyalty cards, wallet-ready
> digital coupons, feedback surveys and real-time analytics. Cheerfy documents a Loyalty Card API
> and a Coupons API for point-of-sale integration.

Generated by the API Evangelist enrichment pipeline on 2026-08-10 from apis.yml and the artifacts in
this repository. Cheerfy does not publish an llms.txt of its own — https://docs.cheerfy.com/llms.txt
returns a 307 redirect into the GitBook application shell.

## Status of the machine-readable contract

- No OpenAPI, AsyncAPI, GraphQL SDL, Postman collection or JSON Schema is published at any Cheerfy
  location. Probed: cheerfy.com, www.en.cheerfy.com, docs.cheerfy.com, api.cheerfy.com,
  webhook.cheerfy.com, auth.cheerfy.com and admin.cheerfy.com.
- The API reference pages at docs.cheerfy.com 307-redirect to app.gitbook.com and render only a
  JavaScript shell, so the documented endpoints are not readable by a machine.
- api.cheerfy.com resolves but returns HTTP 503 on every path — the load balancer behind it has no
  rule for that hostname.
- The one reachable API host, webhook.cheerfy.com, challenges with `WWW-Authenticate: Token` and
  returns `{"detail": "..."}` error bodies (Django REST Framework).

## APIs

- [Loyalty Card API (API Tarjeta de Fidelización)](https://docs.cheerfy.com/es/cheerfy-loyalty/api-tarjeta-de-fidelizacion): Loyalty card integration for point-of-sale systems. Reference is JavaScript-rendered.
- [Coupons API (API Cupones)](https://docs.cheerfy.com/es/cheerfy-loyalty/api-cupones): Coupon redemption from a point-of-sale system. Reference is JavaScript-rendered.

## Docs

- [Documentation](https://docs.cheerfy.com/): GitBook documentation site for the Cheerfy platform.
- [Website](https://cheerfy.com/): Product marketing site.
- [Pricing](https://www.en.cheerfy.com/pricing/loyalty): Cheerfy Loyalty list pricing, per point of sale.
- [Academy / Blog](https://www.en.cheerfy.com/academy): Product updates, release notes and customer stories.
- [Support](https://www.en.cheerfy.com/contact): Helpdesk; support@cheerfy.com.
- [Admin console](https://admin.cheerfy.com/login/): Tenant login where API credentials are issued.
- [Business services terms](https://www.en.cheerfy.com/legal/business-services): Contract terms, GDPR joint-controller and processor arrangements.
- [Privacy policy](https://www.en.cheerfy.com/legal/privacy-policy)

## Artifacts

- [Plans and pricing](plans/cheerfy-plans-pricing.yml): Starter, Professional and Enterprise tiers with bundled sales quota, 1% overage and monthly caps.
- [Rate limits](rate-limits/cheerfy-rate-limits.yml): None published; no rate-limit headers observed.
- [Authentication](authentication/cheerfy-authentication.yml): Probed token authentication profile.
- [Error catalog](errors/cheerfy-problem-types.yml): Observed error envelope; not RFC 9457.
- [Conventions](conventions/cheerfy-conventions.yml): Cross-cutting semantics, with gaps recorded honestly.
- [Changelog](changelog/cheerfy-changelog.yml): Numbered product-release series from the Academy blog.
- [Conformance](conformance/cheerfy-conformance.yml): GDPR committed in the terms; no certifications published.
- [Lifecycle](lifecycle/cheerfy-lifecycle.yml): No versioning policy, deprecation policy, SLA or status page.
- [Well-known](well-known/cheerfy-well-known.yml): No /.well-known/ document on any host.
- [Packages](packages/cheerfy-packages.yml): No first-party SDK in any public registry.
- [Domain security](security/cheerfy-domain-security.yml): TLS, HSTS, SPF, DMARC and DNSSEC probe.