> ## Documentation Index
> Fetch the complete documentation index at: https://docs.tyviso.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Integrations

This documentation covers the Tyviso Events API — GET and POST requests for Offers, Rewards Events, Gift After Purchase, Giveaways, and more, straight from your website or app. Pull your Tyviso data into your own reporting stack: one API key, one header, JSON or CSV out.

<CardGroup cols={2}>
  <Card title="Authentication" icon="key" href="/integration/api-integration/authentication">
    `X-API-Key` — one header on every request. Your key is scoped to your partner ID.
  </Card>

  <Card title="Endpoints" icon="list" href="#endpoint-reference">
    10 across 5 groups — Campaigns, Offers API, Events, Giveaways, and More.
  </Card>

  <Card title="Formats" icon="file-json" href="/integration/api-integration/event-types">
    JSON · CSV — event endpoints accept `format=csv` for spreadsheet pulls.
  </Card>

  <Card title="Quickstart" icon="rocket" href="/integration/api-integration/quickstart">
    Three steps to your first payload — live in about five minutes.
  </Card>
</CardGroup>

<Info>
  Every API key maps to a single partner ID, so you only ever see your own data. Nothing here exposes another partner's events.
</Info>

## Get started

<CardGroup cols={2}>
  <Card title="Quickstart" icon="rocket" href="/integration/api-integration/quickstart">
    If you can run cURL, you can be reading live event data inside five minutes.
  </Card>

  <Card title="Authentication" icon="key" href="/integration/api-integration/authentication">
    How your API key works, and the three headers every request needs.
  </Card>

  <Card title="Rate Limits & Support" icon="gauge" href="/integration/api-integration/rate-limits">
    What to do before you hit a limit, and how to get help fast.
  </Card>
</CardGroup>

## Concepts

<CardGroup cols={2}>
  <Card title="Core Objects" icon="cube" href="/integration/api-integration/core-objects">
    The Offer, Event, and Transaction shapes referenced throughout this reference.
  </Card>

  <Card title="Event Types" icon="chart-line" href="/integration/api-integration/event-types">
    What `type` decides, and which endpoints support which types.
  </Card>

  <Card title="Errors" icon="triangle-exclamation" href="/integration/api-integration/errors">
    401, 404, and 422 — how they behave, and the one gotcha to watch for.
  </Card>
</CardGroup>

## Endpoint reference

<CardGroup cols={2}>
  <Card title="Campaigns" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="bullhorn" href="/integration/api-integration/campaigns">
    Get active offers, trigger campaign push notifications.
  </Card>

  <Card title="Offers API" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="rss" href="/integration/api-integration/offers-api">
    The full feed behind your hosted Rewards page or widget.
  </Card>

  <Card title="Events" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="chart-line" href="/integration/api-integration/external-events">
    Reward events, Gift After Purchase events, push-notification widget data.
  </Card>

  <Card title="Giveaways" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="gift" href="/integration/api-integration/giveaways">
    Giveaway flows, code claims, giveaway event history.
  </Card>

  <Card title="MyAdvertisers" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="handshake" href="/integration/api-integration/my-advertisers">
    Offers for a specific partner by partner ID.
  </Card>

  <Card title="More" color={{ light:"#0B1B2B",dark:"#07C983" }} icon="ellipsis" href="/integration/api-integration/postback">
    Postback and Gruum conversion — supported, lower-traffic endpoints.
  </Card>
</CardGroup>