🗝️API Key

Creating and managing tokens for your Pop

Overview

EyePop uses a standard OAuth system to manage access to your Pops.

In essence, OAuth is a token exchange and management protocol that allows you to create public temporary keys for your authenticated users. Depending on your Pop use case, a temporary key may or may not be necessary so let's explore the main use cases.

The primary Pop use cases are as follows:

1. Server to Server: You or a server talks directly to your Pop.

2. Server to Client: Your clients talks directly to your Pop - temporary keys are required.

Quick Start

1. Go to your Dashboard

   1. Once you're logged in, navigate to your EyePop Dashboard.

   
2. Click “Generate a New API Key”

   1. You should see a button labeled “Generate API Key”. (If you don’t see it, make sure you haven’t already created one—only one API key can be active at a time.)

   
3. Name Your API Key

   1. Give your key a memorable name (e.g., “Starter Integration”, “My App Key”, etc.), then click "Enter a name".

   
4. Copy and Save Your Key

   1. Once your key is generated, copy it immediately—you won’t be able to view it again later.

      

      🔒 Important: Treat this key like a password—don’t share it publicly. If you lose it, you can delete it and generate a new one from your dashboard.