Skip to main content

API Endpoints

Introduction​

This section defines the API contracts through which clients interact with the SalesFam platform. It establishes a consistent interface between the frontend, backend services, and external integrations by documenting endpoint behavior, request and response contracts, validation, authentication requirements, and error handling.

Purpose​

The API documentation provides a shared contract for frontend and backend development and gives each functional requirement a clear interface that can be implemented and tested independently.

Scope​

This section covers:

  • Endpoint definitions and HTTP methods
  • Request and response contracts
  • Authentication and authorization requirements
  • Validation and business rules exposed through the API
  • HTTP status codes
  • Standard success and error responses
  • Integration-facing API behavior

Organization​

API contracts are organized by functional requirement:

  • FR-01 — IAM
  • FR-02 — Merchant & Product Management
  • FR-03 — Rep Onboarding & Commission Contracts
  • FR-04 — Referral Attribution Engine
  • FR-05 — Checkout & Payment Processing
  • FR-06 — Webhook Processing & Order Finalization
  • FR-07 — Financial Ledger, Settlement & Payouts