Migrating Video API from OpenTok to Unified

Objective

The Vonage API Dashboard ("Unified") is the newer Vonage platform for managing Video API alongside other Vonage APIs. Existing OpenTok customers can continue using the OpenTok dashboard, and there is currently no announced end-of-life for the OpenTok environment. 

If you are considering migrating to the Unified environment from OpenTok environment, please first read the Overview section of the main migration guide and contact your Account Manager.

This article is intended as a companion guide to the main migration guide. It focuses on the technical differences between the OpenTok and Unified environments, including authentication, Server SDKs, and Client SDKs, to help customers plan and execute their migration. For additional guidance on common questions, see: OpenTok to Unified Migration FAQ 

Applies To

• Video API customers planning to migrate from the OpenTok environment to the Unified environment

Procedure

Before You Start

Before starting your migration steps, it is helpful to understand the key differences between the two environments.

1. Recognizing Your Environment
   • The first step is to identify which environment you are currently using. For more details, see How to recognize if I’m using Vonage Video API Unified Environment or Vonage Video API OpenTok environment? 
     • OpenTok: https://tokbox.com/account/#/ 
     • Unified: https://dashboard.nexmo.com/
2. Understand the authentication difference
   • The two environments use different terminology and authentication credentials. In the OpenTok environment, each project uses a Project API Key and Project Secret. In the Unified environment, projects are replaced by Applications, and authentication is performed using an Application ID and the corresponding Private Key generated for each application. For more details, see Credential Differences Between OpenTok and Unified Environments 

Migration Steps

This section provides additional technical guidance to complement the main migration guide. If you are working with a Transition Manager, some of the migration steps may differ based on your migration plan. For self-service migrations, you can use the steps below.

1. Sign up for a Unified account and configure billing
   • If you do not already have a Unified account, create one and configure your billing information.
   • New Unified accounts include free trial minutes to help you evaluate the platform.
2. Create a test Application
   • Before migrating your production applications, create a test application in your Unified account to familiarize yourself with the new environment.
   • Complete the steps to create your first application and obtain your Application ID and Private Key. You only need to complete the steps explained in the page – you do not need to continue with the rest of the tutorial.
   • You can also use the Application API to programmatically manage your Unified Applications.
3. Update your Server SDK
   • This article explains the Server SDK changes required for migration.
4. Update your REST API (if applicable)
   • If your application uses the Video REST API, see this article.
5. Update your Client SDK
   • For Client SDK changes required during migration, see this article.