Skip to main content

Multiplayer API Key

The Multiplayer API key authenticates your application when sending session recording data to Multiplayer. Without it, we can’t associate your frontend or backend data with your project. The API key ensures that session recordings, traces, logs, and other data are securely tied to your account.

When to generate it​

You’ll need an API key as part of your configuration:

  • Frontend data (STEP 1): used by the JavaScript Client Library OR CLI Apps to send traces, logs, request/response data and screen recordings.
  • Backend data (STEP 2): used by your backend setup to send traces, logs, and request/response data.

You can:

  • Use a single API key for both frontend and backend data (recommended for most setups).
  • OR, optionally, generate separate API keys for frontend and backend if you want stricter separation or different access scopes.

How to generate it​

Login​

Login into your Multiplayer account. If you don't already have one, create a free trial at go.multiplayer.app.

Generate the Multiplayer API key​

Generating an API key is necessary to complete the JavaScript Client Library OR CLI Apps setup and send frontend data to Multiplayer.

In the onboarding setup wizard:

  • Select "JavaScript Client Library" OR "CLI Apps"
  • (Optional) Rename your API key
  • Click "Create"
  • Copy the key immediately. For security reasons, you won’t be able to view it again later. If you lose it, you’ll need to generate a new one.
  • Follow the remaining steps as indicated in the wizard
  • Proceed to STEP 2 in the wizard

Generate the backend API key​

You should generate the backend API key IF:

(1) You are not using the JavaScript Client Library OR CLI Apps and, instead, you are using the Multiplayer browser extension

(2) You are using the JavaScript Client Library OR CLI Apps, but you want stricter separation of frontend and backend data.

You can generate a second API key in STEP 2

  • Select "Generate the Multiplayer API key"
  • (Optional) Rename your API key
  • Click "Create"
  • Copy the key immediately. For security reasons, you won’t be able to view it again later. If you lose it, you’ll need to generate a new one.
  • Follow the remaining steps as indicated in the wizard
  • Proceed to STEP 3 in the wizard

Best practices​

  • Use environment variables: Store your API key(s) in your deployment environment, not in your code repository.

  • Rotate periodically: Regenerate keys if you suspect compromise or want to enforce rotation policies.

You did it! What’s next?​

To leverage the Multiplayer full stack session recordings at their fullest, make sure to:

If you have any questions or trouble with the configuration, contact us.