# Winerix Reference Data Contracts

Contrats logiques des principaux produits API Winerix : champs, formats, garanties, usages et caveats.

## Synthese

- Contrats : 10
- Produits lies au catalogue : 10
- Produits manquants : 0

## Table copiable

| Produit | Contrat | Formats | Champs requis | Quality gates | Caveat |
|---|---|---|---|---|---|
| Reference Launch Readiness | Launch readiness contract | json, md, csv | ok, generated_at, summary, checks, copy_markdown | required checks present, artifact_missing count reviewed, Publication Gate linked | Declarative readiness does not replace DB imports, runtime endpoint validation or final business review. |
| Reference API Manifest | API manifest contract | json, md, csv | ok, generated_at, summary, products, copy_markdown | endpoint listed for each published product, caveat present, stage present | Manifest is catalog-derived; Publication Gate still controls external display. |
| Reference Citation Kit | Citation contract | json, md, csv | ok, generated_at, summary, citations, copy_markdown | citation present, license present, URL present for official sources, caveat present | Citation URLs and licenses must be reviewed when source pages change. |
| Source-KPI Lineage Matrix | Source lineage contract | json, md, csv | ok, generated_at, summary, sources, copy_markdown | catalog_only reviewed, product_count > 0, kpi_count visible, freshness policy linked when applicable | Lineage is declarative and does not prove database import success. |
| Reference KPI Scorecard | KPI scorecard contract | json, md, csv | ok, generated_at, family_count, families, copy_markdown | hero KPI present, aggregation level present, caveat present, source products present | Scorecard structures KPI logic but does not provide runtime values. |
| Reference Data Room Index | Data room collection contract | json, md, csv | ok, generated_at, summary, collections, copy_markdown | collection has products, entry action present, caveat present | Index routes to products; product exports and gates remain authoritative. |
| Reference Integration Guide | Integration guide contract | json, md, csv | ok, generated_at, endpoint_count, recipe_count, endpoints, recipes, copy_markdown | recipe has caveat, endpoint has preferred format, Publication Gate recipe present | Examples must use absolute URLs in production and handle HTTP failures. |
| Reference Dashboard Blueprint | Dashboard blueprint contract | json, md, csv | ok, generated_at, section_count, sections, copy_markdown | section has KPI slots, visual direction present, actions present | Blueprint is not hydrated; runtime values must come from product APIs. |
| Reference Narrative Deck | Narrative deck contract | json, md, csv | ok, generated_at, slide_count, slides, copy_markdown | slide order present, speaker note present, caveat present | Deck needs runtime values injected before external sharing. |
| Publication Gate | Publication gate contract | json, md, csv | ok, generated_at, status, summary, gates | status visible, fail/warn counts visible, blocking reason visible | Readiness gate does not replace business validation or legal review. |

## Launch readiness contract

**Produit.** Reference Launch Readiness

**But.** Go/no-go checklist before public or partner sharing.

**Champs requis.** ok, generated_at, summary, checks, copy_markdown

**Champs imbriques.** checks.key, checks.area, checks.status, checks.ready_label, checks.evidence_product, checks.pass_condition, checks.next_action, checks.caveat

**Usage consommateur.** Display launch checklist and block external sharing if required checks are unresolved.

**Endpoint.** /api/get_reference_launch_readiness.php?format=json

**Caveat.** Declarative readiness does not replace DB imports, runtime endpoint validation or final business review.

## API manifest contract

**Produit.** Reference API Manifest

**But.** Index product endpoints and copy formats for developers and partners.

**Champs requis.** ok, generated_at, summary, products, copy_markdown

**Champs imbriques.** products.key, products.stage, products.priority, products.json_endpoint, products.markdown_endpoint, products.csv_endpoint, products.caveat

**Usage consommateur.** Build navigation, API docs and integration pickers.

**Endpoint.** /api/get_reference_api_manifest.php?format=json

**Caveat.** Manifest is catalog-derived; Publication Gate still controls external display.

## Citation contract

**Produit.** Reference Citation Kit

**But.** Attach source citations, licenses, URLs and caveats to published KPI.

**Champs requis.** ok, generated_at, summary, citations, copy_markdown

**Champs imbriques.** citations.source_key, citations.source_type, citations.source_name, citations.producer, citations.url, citations.license_label, citations.citation, citations.caveat

**Usage consommateur.** Render source footnotes, slide footers and methodology annexes.

**Endpoint.** /api/get_reference_citation_kit.php?format=json

**Caveat.** Citation URLs and licenses must be reviewed when source pages change.

## Source lineage contract

**Produit.** Source-KPI Lineage Matrix

**But.** Trace source keys to products, KPI slots, exports and governance policy.

**Champs requis.** ok, generated_at, summary, sources, copy_markdown

**Champs imbriques.** sources.source_key, sources.lineage_status, sources.product_keys, sources.primary_kpis, sources.primary_action, sources.fallback_action

**Usage consommateur.** Audit which source supports which KPI or public product.

**Endpoint.** /api/get_reference_source_lineage.php?format=json

**Caveat.** Lineage is declarative and does not prove database import success.

## KPI scorecard contract

**Produit.** Reference KPI Scorecard

**But.** Group KPI into coherent families and aggregation levels.

**Champs requis.** ok, generated_at, family_count, families, copy_markdown

**Champs imbriques.** families.key, families.family, families.north_star, families.aggregation_level, families.hero_kpis, families.source_products, families.caveat

**Usage consommateur.** Power dashboards, slide outlines and KPI navigation.

**Endpoint.** /api/get_reference_kpi_scorecard.php?format=json

**Caveat.** Scorecard structures KPI logic but does not provide runtime values.

## Data room collection contract

**Produit.** Reference Data Room Index

**But.** Route users to the right deliverable by use case.

**Champs requis.** ok, generated_at, summary, collections, copy_markdown

**Champs imbriques.** collections.key, collections.title, collections.audience, collections.objective, collections.entry_action, collections.product_keys, collections.caveat

**Usage consommateur.** Build the public data room or partner onboarding hub.

**Endpoint.** /api/get_reference_data_room_index.php?format=json

**Caveat.** Index routes to products; product exports and gates remain authoritative.

## Integration guide contract

**Produit.** Reference Integration Guide

**But.** Give developers copyable curl, fetch and PHP recipes.

**Champs requis.** ok, generated_at, endpoint_count, recipe_count, endpoints, recipes, copy_markdown

**Champs imbriques.** endpoints.key, endpoints.markdown_endpoint, endpoints.json_endpoint, recipes.key, recipes.language, recipes.snippet, recipes.caveat

**Usage consommateur.** Onboard partner developers and internal UI builders.

**Endpoint.** /api/get_reference_integration_guide.php?format=json

**Caveat.** Examples must use absolute URLs in production and handle HTTP failures.

## Dashboard blueprint contract

**Produit.** Reference Dashboard Blueprint

**But.** Describe UI sections, KPI slots and source products for the reference page.

**Champs requis.** ok, generated_at, section_count, sections, copy_markdown

**Champs imbriques.** sections.key, sections.title, sections.layout, sections.intent, sections.visual_direction, sections.kpi_slots, sections.product_keys

**Usage consommateur.** Drive UI implementation and deck layouts.

**Endpoint.** /api/get_reference_dashboard_blueprint.php?format=json

**Caveat.** Blueprint is not hydrated; runtime values must come from product APIs.

## Narrative deck contract

**Produit.** Reference Narrative Deck

**But.** Provide slide-ready storyline with KPI slots and caveats.

**Champs requis.** ok, generated_at, slide_count, slides, copy_markdown

**Champs imbriques.** slides.slide, slides.title, slides.subtitle, slides.message, slides.kpi_slots, slides.visual, slides.product_keys, slides.caveat

**Usage consommateur.** Generate decks, notes and partner presentations.

**Endpoint.** /api/get_reference_narrative_deck.php?format=json

**Caveat.** Deck needs runtime values injected before external sharing.

## Publication gate contract

**Produit.** Publication Gate

**But.** Expose publish, annotate or block decision before public usage.

**Champs requis.** ok, generated_at, status, summary, gates

**Champs imbriques.** status, fail_count, warn_count, gates.key, gates.status, gates.label

**Usage consommateur.** Prevent public display when required gates are blocked.

**Endpoint.** /api/get_reference_publication_gate.php?format=json

**Caveat.** Readiness gate does not replace business validation or legal review.