koomalooma Partner API

Name: koomalooma Partner API
Brand: koomalooma Partner API
Availability: InStock

✓ Official Vendor SpecMarketingMarketing AutomationapiKey2 EndpointsREST

For Agents

Register customers in a koomalooma loyalty programme and award them points for purchases, referrals, or other actions through a partner-issued API key.

Install Jentic One Beta

Connect the koomalooma Partner API to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the koomalooma Partner API, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Two steps, two machines. Install the instance in a safe environment, then register your agent from wherever it runs.

Step 1: Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Step 2: Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with koomalooma Partner API.

Assign points to a registered user for a specific campaign action such as a purchase or referral

Reference campaign identifiers configured in the koomalooma backend when issuing point commitments

GET STARTED

Start building with koomalooma Partner API

Explore with Jentic

View OpenAPI Document

The koomalooma Partner API lets merchants enrol customers in koomalooma's loyalty Business Process as a Service and award them points for in-app or in-store actions. The API exposes two operations — registering a user and assigning point commitments tied to a defined campaign — while koomalooma handles signup confirmation, points accounting, and reward fulfilment in over 80 countries. Authentication is by API key passed in a header. The service is intended for mobile and web stores running referral, purchase, or engagement-based loyalty programmes.

Use Cases

Patterns agents use koomalooma Partner API for, with concrete tasks.

★ Purchase reward issuance

When a customer completes a checkout in a merchant's online store, the merchant calls the koomalooma Partner API to assign campaign points tied to the purchase. koomalooma handles points balance accounting, tier progression, and reward delivery in 80+ countries, removing the need for the merchant to build a loyalty backend. Implementation is typically a one-day effort once campaign IDs are configured in the koomalooma dashboard.

Call POST /users/{user_id}/commitments with the user's koomalooma user_id and the purchase campaign ID to credit the configured point amount.

Referral programme onboarding

A referral landing page collects a new customer's details, registers them in koomalooma via POST /users, and immediately awards referral points to both the new and referring users via separate commitment calls. koomalooma manages the referral chain, country eligibility, and fraud checks. The pattern is widely used by mobile app and DTC ecommerce teams to launch referral programmes without standing up a loyalty service.

Register a new user with POST /users using the referral landing form data, then call POST /users/{user_id}/commitments with the referral campaign ID.

In-app engagement rewards

A mobile app awards points for non-purchase actions — completing a profile, posting a review, sharing on social — by mapping each action to a koomalooma campaign and calling the commitments endpoint when the action fires. koomalooma tracks the user's running balance and triggers reward delivery when thresholds are met.

When a user completes their profile, call POST /users/{user_id}/commitments with the 'profile-complete' campaign ID to credit 50 points.

Agent-managed loyalty actions via Jentic

An AI agent handling post-purchase customer workflows searches Jentic for 'award loyalty points' and is matched to the koomalooma commitments operation. The agent reads order data from the merchant system, calls Jentic to execute the points commitment with the correct campaign ID, and confirms the response — without holding the koomalooma API key in its context.

Use Jentic to load koomalooma_assign_points, then execute it with user_id 'u_12345' and campaign 'purchase-tier-1' for a verified order.

Key Endpoints

2 endpoints — the koomalooma partner api lets merchants enrol customers in koomalooma's loyalty business process as a service and award them points for in-app or in-store actions.

METHOD

PATH

DESCRIPTION

POST

/users

Create a user in the partner programme

POST

/users/{user_id}/commitments

Assign campaign points to a user

POST

/users

Create a user in the partner programme

POST

/users/{user_id}/commitments

Assign campaign points to a user

Why Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

The koomalooma partner API key is stored encrypted in the Jentic vault (MAXsystem). Agents receive a scoped capability — the key is injected at request time and never written into agent prompts.

Intent-based discovery

Agents search Jentic by intent such as 'award loyalty points' and receive the koomalooma commitments operation with its input schema, so the correct user_id and campaign ID are surfaced explicitly.

Time to first call

Direct koomalooma integration: 1-2 days for partner key setup, campaign mapping, and retry handling. Through Jentic: under an hour — search, load, execute.

FAQs

Specific to using koomalooma Partner API through Jentic.

What authentication does the koomalooma Partner API use?

The API uses an API key passed in the request header. Jentic stores this key encrypted in MAXsystem and injects it per call so the agent never sees the raw secret.

Can I create users and award points in a single call with the koomalooma Partner API?

No. User creation is POST /users and points assignment is a separate POST /users/{user_id}/commitments. A typical flow chains the two in sequence using the user_id returned by the first call.

What are the rate limits for the koomalooma Partner API?

Rate limits are not declared in the spec. koomalooma applies per-partner ceilings — contact support@koomalooma.com for the limit on your account and design retries with exponential backoff.

How do I award referral points through Jentic?

Search Jentic for 'award loyalty points', load the POST /users/{user_id}/commitments operation, and execute it with the referral campaign ID configured in your koomalooma backend. Install the SDK with pip install jentic to call it from Python.

Does the koomalooma Partner API let me read a user's points balance?

No read endpoint is exposed in this spec. The Partner API covers user creation and points commitments only — balance lookups and reward redemption are handled inside the koomalooma platform.

koomalooma Partner API

Connect the koomalooma Partner API to your agent

Capabilities

Start building with koomalooma Partner API

Use Cases

Key Endpoints

Why Jentic?

Related APIs

FAQs