Versions Compared

Old Version 5

changes.mady.by.user Chitra Borker (Deactivated)

Saved on

compared with

New Version 6

changes.mady.by.user Chitra Borker (Deactivated)

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

There are two options to connect your project to your custom UI, using web API keys or using a token server. The easier and more secure option is using the web API keys method.

Connect Using API Keys

On a high level you would need to follow the below steps:

  1. Create and deploy your project from Digital DNA Studio > New Project.

  2. Create a web API key and assign it to your project from the settings cog > API Keys > Create API Key.

  3. To connect to your UI, pass in your web API key as an option when constructing your scene.

Creating API Key to Connect to Digital Person

Create a web API key from the settings cog icon on the top right corner of the screen, select API Keys andclick Create API Key. The new API Key can then be assigned to your project with the specified domains it can be authenticated against. Once you create the key, you cannot edit it, you will need to revoke and create a new one instead.

Field

Description

Name

Name for the new API key.

Scope

Choose Web for configuring a Web API Key.

Assign Project

Start typing the name of the project you wish to generate the API key for. Choose the name of the project from the dropdown list. You can search the project using the project name or project ID.

Info

Note: The project must be deployed before you create a Web API Key.

I'm Developing Locally

If you are developing locally for testing your project, enable this toggle and enter the Public IP Address IPv4 or IP46 with Subnet Mask.
For example, 92.0.2.1/24 or 2001 : db8: 3333 : 4444 : 5555 : 6666 : 7777 : 8888.
You will also need to supply your full localhost URL with port number as a Custom UI Domain: http://localhost:8000/

Enable cross page persistence

This toggle allows the session with Digital Person to continue across multiple pages on a domain or subdomain. See Session Persistence for more details.

Custom UI Domain

When you are ready for deploying the project, specify one or more web domain(s) in the Custom UI Domains field.

Expiration

The expiration for web API key is set to never by default. Until its revoked manually.

On successful creation, the API key is displayed for you to save or copy. Once your API Key is generated, you can view it at any time on the API Keys view screen.

Info

You should revoke the key if it becomes inactive, lost, or compromised. For details see Revoke API Key.

Note

If you have an orchestration server, you should use the advanced connection configuration on the Project Summary page. For details see Connecting using Token Server.

Related Topics

Contents

Table of Contents
minLevel1
maxLevel7