Need help setting up v2 apis for testing.

[ShashwatPS]

Actually i am setting up the v2 apis locally for testing. Having some trouble doing so , would be helpful if someone is able to provide a high level overview of how to do it.

[dosubot[bot]]

Here’s a high-level overview for setting up the v2 APIs locally for testing:

1. Make sure you have Node.js (>=18.x), PostgreSQL (>=13.x), and Yarn installed. Clone the repo, install dependencies with yarn, and set up your .env file using .env.example as a template. Generate secrets as needed for NEXTAUTH_SECRET and CALENDSO_ENCRYPTION_KEY source.

2. In your database, add a license key to the deployments table. The license key must also be set in your .env file as CALCOM_LICENSE_KEY, and both values must match exactly source.

3. Set key environment variables in your .env file, including:

   • NEXT_PUBLIC_API_V2_URL (default: http://localhost:5555/api/v2)
   • CALCOM_LICENSE_KEY (must match DB)
   • NEXT_PUBLIC_VAPID_PUBLIC_KEY (generate with npx web-push generate-vapid-keys)
   • REWRITE_API_V2_PREFIX (set to 1 to rewrite /api/v2 to /v2)
   • API_KEY_PREFIX (usually cal_)
   • GET_LICENSE_KEY_URL (valid Cal.com license endpoint)
   • Any other required service keys from .env.example source, source.

4. Run database migrations with yarn workspace @calcom/prisma db-migrate.

5. Start the v2 API server from the apps/api/v2 directory using yarn dev. This builds dependencies, starts Docker (if needed), copies Swagger modules, and launches the API in watch mode source.

6. Visit /docs on your API server (e.g., http://localhost:5555/docs) to view Swagger documentation and verify available endpoints source.

Common issues: 404 errors usually mean your license key is misconfigured or missing in either the DB or .env. After changing environment variables, always restart the API service. For VAPID key errors, set NEXT_PUBLIC_VAPID_PUBLIC_KEY and restart. For 401 errors with SDK integrations, add your localhost URL to Redirect URIs in platform settings source, source, source.

If you run into specific errors, let me know what you’re seeing and I can help troubleshoot further.

To reply, just mention @dosu.

---

^{How did I do? Good | Irrelevant | Incorrect | Verbose | Hallucination | Report 🐛 | Other}