Playbook: Adding a New API

This playbook describes the process for adding a new API endpoint to the Salescentri platform.

Prerequisites

  • Access to the API codebase
  • Understanding of existing API patterns (see v2 Wallets for reference)

Steps

  1. Design - Define the endpoint contract (method, path, request/response schema)
  2. Implement - Add handler following existing patterns
  3. Document - Add documentation in the appropriate docs/api/ section
  4. Test - Write and run integration tests
  5. Review - Submit for code review
  6. Deploy - Follow standard deployment process

Checklist

  • OpenAPI/Swagger spec updated
  • Documentation added to docs
  • Changelog updated
  • Tests passing