Skip to main content

API Notes

This project talks to two external APIs.

FAQ API​

Used by FaqApiClient:

  • Retrieves an auth token
  • Fetches “standard format” issue types and loads them into SQLite

Environment variables:

  • FAQ_API_BASE_URL
  • FAQ_API_USERNAME
  • FAQ_API_PASSWORD

CSM 1.0 API​

Used by Csm1ApiClient:

  • Retrieves an auth token for a given task (default: quality)
  • Submits quality reports using ImportQuality

Environment variables:

  • CSM_API_BASE_URL
  • CSM_API_SECRET
  • CSM_API_SERVICE_CENTER

Security​

  • Credentials/secrets should be provided via environment variables (or a local .env file).
  • Do not print or persist tokens unless strictly necessary.
  • Avoid enabling verbose HTTP logging unless debugging, and never in shared logs.
  • API-related menu/CLI actions will fail if required credentials are not set.