Creating and managing API keys

The PixelSpyer API lets you use PixelSpyer data in your own tools, dashboards and workflows. API access is included with the Agency plan.

Before you start

• You need an active Agency plan. See Plans and limits.
• Read the API documentation at /api-docs for endpoints, authentication and examples.

Create an API key

1. Go to your account settings at /app/settings.
2. Find the API keys section and create a new key.
3. Copy the key straight away and store it somewhere safe, such as a password manager or your server's secret storage.

Your key is shown only once. If you lose it, you cannot view it again. Revoke it and create a new one.

Use your key

Send your key with each request as described in /api-docs. Keep the key on your server or in a backend process. Never put it in front-end code, mobile apps, browser extensions or public code repositories, where anyone can read it.

Revoke a key

Revoke a key when you no longer need it, when someone who had access to it leaves your team, or if you think it has been exposed.

1. Go to your account settings at /app/settings.
2. Find the key in the API keys section.
3. Revoke it.

A revoked key stops working, so move your integrations to a new key first if you still need them.

Replace a key without downtime

1. Create a new key.
2. Update your integration to use the new key.
3. Check that requests succeed.
4. Revoke the old key.

Keep keys private

• Do not share keys by email, chat or in support requests.
• Where you can, use a separate key for each integration, so you can revoke one without affecting the others.
• Do not commit keys to code repositories, even private ones.

Related

• API limits and best practices
• Managing account settings and your password
• Plans and limits