Introduction

To interact with the Eagle Eye Video API Platform, you need Client Credentials. These credentials are tied to specific applications. For instance, if a partner wants to integrate Eagle Eye API v3 with both a web and mobile app, they need to create two separate sets of Client Credentials.

This guide outlines the steps to create and manage your Client Credentials. The following video shows the steps to take to create an application and obtain Client Credentials.

Procedure

1. Do either of the following:

• Create a new Eagle Eye account. To create a new Eagle Eye account, click here.

After completing the sign up form and clicking the Sign up button, you'll receive a welcome email. Follow the instructions to confirm your email and set up a password.

• Log on to your existing account.

📘

Note

Client Credentials are linked to Eagle Eye accounts. Once your account is set up, you can create Client Credentialss and associate them with it.

2. Log into My Application

Once your account is set up, navigate to the My Application portal and log in using your username and password.

Note: Only admin users can create an application and client credentials.

3. Head to the Manage applications section, click the Add application button, and fill out the form.

📘

Note

If you are integrating the Eagle Eye API with a mobile or web application that lacks a secure backchannel for storing access tokens, enable the Public toggle. Public Client Credentials only receive a temporary access token upon authentication.

For cloud or web applications with a secure backchannel, keep the Public toggle off. This will set the client credential type to Confidential, allowing you to receive both a refresh token and an access token after authentication. Store refresh tokens only on secure servers and never share them client-side.

4. After setting up an application, you can add Client Credentials to it. To do this, click on the three dots next to the name and description of the application, and choose See Client Credentials option.

5. To associate Client Credentialss with your application, whitelist the redirect URLs you are going to use to request OAuth tokens.

> 📘 Note

You can create multiple Client Credentialss under a single application, and a single account can have multiple associated applications.

Result: You have successfully created your first set of Client Credentials. You can now obtain an access token and/or a refresh token by using these credentials for basic authentication, as outlined in Logging in.