APIs integration

Alternative: the hosted storefront (Vibe Coding Kit)

The direct API integration in these docs is for merchants who already have a website with its own backend. Ping Business also supports a second path that ships everything for you.

When to choose which

Direct API (these docs) Merchant Store Vibe Coding Kit
You have An existing website + backend A logo and product photos
Customer accounts Your existing login system Included (Keycloak-based, with registration/login)
Catalog pages You render them from GET /products Complete customizable Angular storefront
Checkout Your backend drives intents + callbacks Built in, including subscriptions
Hosting Your infrastructure One-click-style deploy to Railway, Northflank, or your own server
Effort A backend integration (this doc set) Fill in a form, hand the generated prompt to an AI coding agent

What the kit is

An Apache-2.0 public kit at https://github.com/PingBusiness/PingBusiness (directory merchant-store-vibe-coding-kit/) containing:

  • a reference merchant-store UI (Angular) you customize with an AI coding agent (ChatGPT, Claude, Cursor, …) via a generated prompt;
  • estore-app, a merchant-hosted backend that exposes a customer-safe storefront API and holds your Ping Business credentials server-side;
  • a portable Keycloak realm for customer accounts, deployment adapters, and DNS/TLS/backup automation.

Both paths converge on the same platform: the kit's estore-app calls exactly the API documented here with your same three credentials. You can even mix them — e.g. run the kit's storefront on shop.example.com while your main site links to it.

Where to go

  • Kit page: https://github.com/PingBusiness/PingBusiness/tree/main/merchant-store-vibe-coding-kit
  • Launcher (customize + deploy prompt generator): website/pingbusiness-store-launcher.html in the kit
  • The kit's own customer-facing API spec: docs/ESTORE_APP_API_SPEC.md in the kit — relevant if you build a custom frontend against a deployed estore-app instead of against the Ping Business API directly.