Getting Started

Quick Start

This guide provides a high-level overview of the Otonum integration journey, from your first API key to your first rewarded member transaction.

For exact request and response formats for each endpoint, see the API Reference.

Before You Begin

Make sure you have:

An active Otonum account (sign up at otonum.io)
Access to your Otonum Rewardsapplication

Create your API key

Every request to Otonum API is authenticated with a secret API key linked to your account. In your Otonum Rewards application, go to Applications -> API Access -> New client secret.

Store it in an environment variable. It is shown only once and provides full access to your loyalty data.

See Authentication for key handling best practices.
Understand your program settings

Before building your integration, read application settings to understand program rules: earning rates, redemption thresholds, and expiration policies.
- Cashback program: percentage returned per transaction, and minimum balance before redemption is available.
- Points program: point-to-cash conversion value, and minimum points required to create a redemption voucher.
See Application Settings for full details.
Enroll your members

A member must be enrolled before earning or redeeming rewards. You can enroll members individually (during signup or opt-in) or in bulk (when migrating an existing database).

Each enrolled member receives a personal code, a short identifier presented at checkout to link transactions to member account.
Submit purchases

Whenever a member completes a transaction in your system, submit it to Otonum. The platform evaluates the purchase against active campaigns and calculates applicable rewards asynchronously.

Always use your internal activity ID as reference to prevent duplicate processing during retries.
Show feedback to the member

After purchase submission, Otonum notifies the member automatically (email or push, depending on your settings). Optionally, query Task Status to confirm completion and show earned rewards in your own UI.

Next Steps

Authentication: Key management and security
Member Identity: Personal codes and member balances
Campaigns: How reward rules are evaluated
Integration Guide: End-to-end checkout flow
Best Practices: Error handling, rate limits, and resilience

Last modified on July 3, 2026

About Otonum Authentication

Before You Begin

Make sure you have:

An active Otonum account (sign up at otonum.io)

Access to your Otonum Rewardsapplication

Create your API key

Every request to Otonum API is authenticated with a secret API key linked to your account. In your Otonum Rewards application, go to Applications -> API Access -> New client secret.

Store it in an environment variable. It is shown only once and provides full access to your loyalty data.

See Authentication for key handling best practices.
Understand your program settings

Before building your integration, read application settings to understand program rules: earning rates, redemption thresholds, and expiration policies.
- Cashback program: percentage returned per transaction, and minimum balance before redemption is available.
- Points program: point-to-cash conversion value, and minimum points required to create a redemption voucher.
See Application Settings for full details.
Enroll your members

A member must be enrolled before earning or redeeming rewards. You can enroll members individually (during signup or opt-in) or in bulk (when migrating an existing database).

Each enrolled member receives a personal code, a short identifier presented at checkout to link transactions to member account.
Submit purchases

Whenever a member completes a transaction in your system, submit it to Otonum. The platform evaluates the purchase against active campaigns and calculates applicable rewards asynchronously.

Always use your internal activity ID as reference to prevent duplicate processing during retries.
Show feedback to the member

After purchase submission, Otonum notifies the member automatically (email or push, depending on your settings). Optionally, query Task Status to confirm completion and show earned rewards in your own UI.