Getting started

In other to integrate video functionality into your web or mobile application you need to do the following:

Registering for a Vonage account

To get started you need to register for a free Vonage account.

After registering, you will be directed to the Vonage dashboard. If you already have an account, simply log in.

You can create and make changes to all your Vonage projects right from the dashboard.

Create an application

After logging into your Vonage dashboard, the next step is to create an application for your Vonage video project.

Follow these steps to do so:

  1. From the left-hand navigation click on Applications.
  2. From the Applications page, click on Create a new application (top right) to create a new application.
  3. Provide a name for your project.
  4. Click on Generate public and private key to generate your secret key. Download and keep it safe.
  5. Toggle the Video capability on
  6. You can also set up callback URLs to capture events and monitoring data from here, we will leave those empty for now.
  7. Scroll to the end of the page and click on Generate new application at the bottom right to create your video application.

Authentication

After your application is generated, you should be able to view the credentials listed below:

  • Application ID: This is a unique alphanumeric identifier for your video application.
  • API Key: This forms part of your authentication credential in case you authenticate using basic auth. (We won't be using this option here).
  • Private key: This key is used for JWT-based authentication. Please ensure it is kept in a secure location.

When it comes to authentication for your video application, you will need to use the Application ID (App ID) and private key.

Creating your first application

It's time to integrate video streaming into your application.

Client & Server SDKs

Let's begin with the client SDKs. These SDKs enable video integration into your application by connecting users to your streams via the Vonage video servers.

In other to use the Client SDKs you will need three key credentials:

  • App ID and Private key: This combo serves as your authentication key. We talked about how to generate these credentials in the section above
  • Session IDs: These IDs are used to identify an active video stream that users can join, similar to a "room". Learn more from the sessions guide.
  • Token Users require a unique token to access video sessions. All privileges will be associated with this token.)

Session IDs and tokens can be generated using the Server SDKs. Once generated you can send this over to the client side of your application to be used by the Client SDK.

Once you have a working Vonage video session, you can connect users to it. Refer to the guide on joining sessions to learn how to do this in your preferred programming language.

Also, One of the quickest ways to set up a web-based Vonage video stream is by using Video Express.

Next step

The Vonage video platform provides a host of configurations and add-ons to help you create your desired video experience.

Here are some helpful guides:

To learn more about video-related terminologies, please visit the Technical Details guide.

  • Visit the pricing section to learn about the Vonage video platform pricing.
  • Vonage video + AI: Learn how you can enhance your video experience using AI.
  • Media processor: Learn how to pre-process your video streams before users see them. For example, audio translation for a multi-lingual video stream.
  • Tools and debugging: The Vonage video platform provides several tools to help with debugging during and after your development.