Onboarding

Onboarding is a one-time exchange between your team and Cheggout. It is usually the long pole in an integration, so start it before you write code.

What gets exchanged

Item	Direction	Needed for
CHANNELID	Cheggout → you	Every API call
Your public key	You → Cheggout	Cheggout verifying your signatures
Cheggout's public key	Cheggout → you	You verifying Cheggout's responses
Egress IP addresses	You → Cheggout	Server-to-server access
API key + secret	Cheggout → you	Deals Store APIs only
Placement IDs	Cheggout → you	Advertisement module
Trigger event codes	Agreed jointly	Scratch cards

Keys and secrets are backend-only

Your private key and any API secret must live on your server, in a secret manager. Never in a mobile binary, never in JavaScript, never in a repository. A key that has been in an app package must be treated as compromised and rotated.

Prerequisites checklist

Work through this with your Cheggout contact.

Security

• Public key certificates exchanged in both directions. All communication is HTTPS and requests are signed using SHA256withRSA. See Key generation to produce your key pair.
• Server IPs shared for whitelisting. Every IP your backend can call Cheggout from, in both UAT and production. Re-share whenever infrastructure changes.
• API key and secret received (Deals Store integrations only).

Identity

• virtualId scheme decided. Unique per user, immutable, no PII. See Core concepts.
• Virtual ID generation service available to Cheggout and to your application vendor, if a third party builds your app.

Product

• Modules confirmed — see Integration models.
• Trigger event codes agreed for scratch cards.
• Placement IDs issued for advertisement placements.
• Campaigns configured by Cheggout for your channel, in UAT first.

Surface-specific

• Mobile SDK — SDK artifacts (AAR / framework) and the version you'll integrate.
• Web widget — script URL for your channel.
• Hosted experience — launch URLs and whether you want a Cheggout subdomain (https://yourbrand.cheggout.com) or your own branded domain (https://yourrewardsstore.com).
• Push notifications — decide whether Cheggout calls your push API, or you share FCM credentials for Cheggout to send directly. See Push notifications.

The process itself

TBD Cheggout does not yet publish a self-service onboarding procedure. There is no portal to request credentials, no standard form for submitting certificates and IPs, and no published turnaround time. Today this happens over email with your Cheggout contact.

This is the single largest blocker to a fully self-service integration and is the top item on Open Items. Until it exists:

1. Contact Cheggout through your commercial owner or via Support.
2. Ask specifically for: CHANNELID, UAT endpoints, key exchange, IP whitelisting, and campaign setup for the modules in your scope.
3. Confirm which environment your first credentials apply to — UAT and production credentials are separate.

While you wait

You can do most of the preparation before credentials arrive:

• Generate your key pair (Key generation).
• Implement the signed envelope and unit-test it against your own key pair.
• Decide and implement your virtualId scheme.
• Build the caching layer for the catalogue, if you're integrating Deals.
• Read the module guide for your scope and map the journey onto your screens.

Next

• Quickstart — your first successful call.
• Authentication — the signing scheme in detail.