Aplauso REST API Overview

The Aplauso REST API is a stateless HTTP API built on Google Cloud Functions (Node.js 20, TypeScript). It provides programmatic access to all core platform resources: tips, ratings, employees, properties, analytics, and more.

Base URLs

All production endpoints use HTTPS. All paths are prefixed with /v2/.

API Version

Current version: 2.0.0. There are no legacy versions maintained. All current clients should use /v2/ paths.

Data Format

All requests and responses use JSON.

• Content-Type: application/json is required on POST, PATCH, and PUT requests.
• Dates are ISO 8601 strings (e.g. 2026-03-25T14:00:00Z).
• Currency amounts are decimal numbers (e.g. 25.50), not cents.

Available Resources

Architecture Notes

• Each resource is served by an independently deployed Google Cloud Function.
• Functions are stateless - no session state is stored between requests.
• Data is persisted in Firebase Firestore (real-time document database).
• Analytics data is served from Google BigQuery with a Firestore fallback.
• Authentication uses Firebase ID Tokens (see API Authentication).

CORS

The API allows cross-origin requests from the following origins:

• localhost:3000 through localhost:8081 (local development)
• https://k.aplauso.io, https://my.aplauso.io, https://aplauso.io
• https://*.vercel.app (preview deployments)

Custom origins for server-to-server integrations do not require CORS headers.

Environment Isolation

Every business logic endpoint accepts an environment parameter (live, sandbox, or demo) to isolate data between production, testing, and demonstration scenarios. See Environments and Sandbox Testing for details.

Status Codes