Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.yuko.so/llms.txt

Use this file to discover all available pages before exploring further.

Where to find this: API key generation — Shopify admin → Apps → Yuko Loyalty → Integrations → REST API.
Reference: API Reference.

​
What you can do

The Yuko REST API exposes the same data the dashboard shows:
  • List, retrieve and update customer points balances.
  • Issue manual points credits / debits.
  • List rewards, VIP tiers, earning rules and referrals.
  • Read activity feeds and points transactions.
Full endpoint reference is in the API Reference tab — this page covers setup and best practices.

​
When to use

  • Custom storefronts (Hydrogen, headless).
  • Server-side automations that need to read or write Yuko data.
  • Migrating customers from another loyalty program.
  • Building admin tools that show Yuko data alongside your other systems.

​
Before you start

Yuko app is installed on your Shopify store — see Install Yuko on Shopify.
The Yuko Theme App Embed is enabled in your active theme.
Your loyalty program is enabled at Shopify admin → Apps → Yuko Loyalty → Loyalty → Settings.
Points label and currency are configured.

​
Setup

1

Open REST API settings

Go to Apps → Yuko Loyalty → Integrations → REST API.
2

Generate an API key

Click Generate key, name it (e.g., “Migration script”), and copy the key.
3

Store the key securely

Treat it like a password — use environment variables, not source files.
4

Authenticate requests

Send the key as a Bearer token in the Authorization header. Details: API → Authentication.

​
Authentication

All requests use Bearer token authentication. Full details: Authentication.

​
Pagination, errors, rate limits

​
Best practices

Rotate API keys quarterly and immediately when a developer leaves.
Use webhooks instead of polling for real-time data — the REST API is for reads and on-demand writes.
Tag every key with a name so you can revoke a single integration without breaking others.

​
FAQs

Strongly recommended. It limits blast radius if one is leaked.
See Rate Limits in the API Reference.
Yes — from Integrations → REST API, click the key and select Revoke. Revocation is immediate.

REST API

Read and write Yuko data programmatically.

Webhooks

Receive real-time event notifications.

Shopify Flow

Trigger Shopify Flow workflows from Yuko events.

Klaviyo

Sync customers, points and tier data into Klaviyo.

Omnisend

Sync loyalty data into Omnisend.

Engati

Conversational AI for loyalty events.

KwikEngage

Multi-channel messaging (SMS, WhatsApp).

Retainful

Email marketing & abandoned cart recovery.

Facebook & Instagram

Social verification for like / follow campaigns.

Google Business

Google Business profile and reviews.

Custom Apps

OAuth or API-key based custom integrations.

Book a Free Setup Call

Talk to our team for personalised setup help.Time: 30 minutes

Contact Support

Visit our support hub for help articles, live chat and ticket submission.

Browse the Guides

Documentation across loyalty, referrals, memberships and more.

Install Yuko

Add Yuko to your Shopify store from the Shopify App Store.