Skip to main content

Getting Started

Get Paylode in front of your customers — a branded perks page, a gift-card handout, or a full reward journey — and know how to prove it's working.

This section takes you from an empty account to a live integration. The big decision up front is how you integrate: drop in a no-code embed, point people at a Paylode-hosted page, or build directly against the API for full control. You don't have to pick one forever — most teams start with an embed and reach for the API only where they need to compose the experience themselves.

The path through this section

Paylode provisions your account for you — there's no self-serve signup. Your point of contact sends your login details, and your API key lives in the admin app. From there, follow these in order the first time, then use them as reference:

  1. Authenticate — put your API key on every request and make your first authenticated call.
  2. Choose an integration option — embed vs hosted vs full API, and which capabilities your team can self-serve without an engineer.
  3. Plan your implementation — scope the rollout: the outcome, the first surface, the two roles, the milestones.
  4. Platform basics — the ground rules every integration relies on: hosts, transport, timeouts, and what the platform does and doesn't do for you.
  5. Error handling — the shared status and error-body conventions every Paylode API follows.
  6. Verify your deployment — confirm Paylode is live on your page in under five minutes.

Stuck at any step? Get help explains where to ask and what to include so the first reply is the useful one.

Before you write any code

If the terms above are new, read the overview of the product you're integrating first — Perks Marketplace, Perk Pages, or Boost. Each one explains what the product does and defines its concepts in plain language, so the guides that follow make sense. A product manager can plan an entire integration from a product overview and Integration options alone, without touching the API.