API & Developers

API Quickstart: Your First Tip in Under 5 Minutes

A step-by-step walkthrough for developers: authenticate, look up an employee, create a tip in sandbox, and verify the result.

API Error Handling: Codes, Formats, and Troubleshooting

A reference for all Aplauso API error codes, the error response format, Zod validation errors, and how to handle common failure scenarios.

Environments and Sandbox Testing: live, sandbox, and demo

How the Aplauso API environment parameter works, how to use sandbox mode for development and testing, and how to run end-to-end tests without affecting live data.

Stripe Webhooks: How Aplauso Finalizes Payments

How the Aplauso Stripe webhook endpoint works, which events it handles, and how to test webhook processing locally.

Analytics API: Querying Performance Metrics

How to use the /analytics endpoint to query tip totals, average ratings, leaderboards, time-series data, and conversion funnels by employee, property, or organization.

Wallet API: Stripe Connect Status and Payout Management

How to use the /wallet endpoint to check Stripe Connect wallet status, initiate onboarding, get login links, and query dividend balances.

Employees API: Creating and Querying Employee Records

How to use the /employees endpoint to create employee records, look up by short code, and query your team.

Ratings API: Creating and Querying Star Ratings

How to use the /ratings endpoint to create guest star ratings, link them to tips and visits, and query rating history.

Tips API: Creating and Querying Tip Transactions

How to use the /tips endpoint to create tip transactions, query tip history, update tip status, and handle idempotency.

API Authentication: Firebase ID Tokens and Roles

How to authenticate API requests using Firebase ID tokens, what roles control access, and how to obtain a token from Firebase.

Aplauso REST API Overview

An introduction to the Aplauso REST API: architecture, base URLs, versioning, supported resources, and how to get started.