Skip to main content
The Partner Integration Framework lets your product — a helpdesk, CRM, review platform, or email tool — connect to Appstle Loyalty on behalf of many merchants. Instead of asking each merchant to create and paste an API key, your app completes a one-time handshake per store and receives a scoped API token for it.
Is this the right framework for you? The Partner Integration Framework is for products that connect to Appstle for many merchants, such as helpdesks, CRMs and email platforms. Appstle onboards your product once, and each merchant then approves its connection.If you’re building an app or tool for one store, your own or a client’s, you don’t need to be a partner. Create a regular API key in that store’s Appstle admin instead. It can be Read only, needs no callback URL and works once the store’s plan includes API access. See Creating an API key and Key permissions.

How a connection works

1

Appstle onboards your app once

You receive a Partner ID and Partner Secret used only for connection calls.
2

A merchant connects your app

From your product’s UI.
3

The merchant approves

Connections your app initiates stay pending until the merchant approves them in Appstle. Pending requests expire after 30 days.
4

Your app receives a scoped token

Appstle delivers a merchant-specific apst_... token to your callback. Send it as X-API-Key on Admin API calls — exactly like a regular API key.
When a merchant disconnects your app — or uninstalls Appstle — the token is revoked immediately.

Why use it

  • No API plan required — merchants are never billed for partner API usage
  • One isolated token per merchant — no shared credentials, no manual key exchange, individually revocable
  • Merchant-controlled — merchants see, approve, and disconnect partners from their own dashboard
  • Automatic cleanup — access is revoked the moment a merchant disconnects or uninstalls

Access levels

Your app’s permission level is set during onboarding:

Connection modes

Get started

Email support@appstle.com with your company name, product description, base URL, and contact email to get onboarded. Then follow the Partner integration guide for the full implementation — endpoints, handshake, callbacks, and testing.