Skip to main content
This section is the hands-on guide for wiring Qyren into your game. If the Quickstart was the tour, this is the manual.

​
What you need before you start

  • A Qyren account (sign up at qyren.ai).
  • A game registered in the dashboard. This gives you a game_id.
  • An API key. Test keys are prefixed qyr_test_, live keys qyr_live_. You can grab both from the dashboard.
  • A server you control that can make outbound HTTPS calls. All Qyren integration is server-to-server. Your game client never talks to Qyren directly — your game backend does.

​
What you’ll build

Four steps, in order. Each one is a separate page in this section.
  1. Send events. Stream gameplay, economy, and monetization events from your game server to POST /v1/ingest. This is the foundation — every dashboard, alert, and recommendation is derived from these events. See REST API and Event Schema.
  2. Import your offer catalog. Upload the offers you sell — IDs, prices, contents, targeting tags — to POST /v1/offers/import. Re-upload whenever the catalog changes. See Offer Import.
  3. Wire up recommendations. When a player hits a trigger (shop open, level complete, boss defeat), call POST /v1/recommend and display the offers Qyren returns. See REST API.
  4. Verify. Use a qyr_test_ key against sandbox endpoints to confirm events landed, offers parsed, and recommendations returned. See Testing.

​
Pages in this section

  • REST API — auth, base URL, the three core endpoints, code samples.
  • Event Schema — the envelope, required fields, full JSON examples per event type.
  • Offer Import — bulk catalog upload, upsert behavior, limits.
  • Testing — sandbox keys, verifying events landed, common errors.
  • Unity SDK — placeholder, coming soon.
  • Unreal SDK — placeholder, coming soon.
Questions or stuck on something specific? Email [email protected].