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 and click on the hamburger icon in the upper right hand corner.

   
2. Select “API Keys”

   1. This will take you to a menu of all the API Keys you have generated for your account and will also allow you to create and delete keys.

   
3. Create API Key

   1. Select the "Create API Key" button to create a new key. Give your key a memorable name (e.g., “Starter Integration”, “My App Key”, etc.) and choose an expiration date for the key by clicking on the drop down arrow. Finally, click "Create"!

   

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.