Skip to main content

Agora account management

This page shows you how to sign up for an Agora account, create a new project, and get the app ID and app certificate to generate a temporary token.

Get started with Agora

To join a Signaling session, you need an Agora App ID. This section shows you how to set up an Agora account, create an Agora project and get the required information from Agora Console.

Sign up for an Agora account

To use Agora products and services, create an Agora account with your email, phone number, or a third-party account.

  1. Go to the signup page.

  2. Fill in the required fields.

  3. Carefully read the Terms of Service, Privacy Policy, and Acceptable Use Policy, and tick the checkbox.

  4. Click Continue.

  5. Enter your verification code and click Confirm.

  6. Follow the on-screen instructions to provide your name, company name, and phone number, set a password, and click Continue.

Once you sign up successfully, your account is automatically logged in. Follow the on-screen instructions to create your first project and test out real-time communications.

For later visits, log in to Agora Console with your phone number, email address, or linked third-party account.

Create an Agora project

To create an Agora project, do the following:

  1. In Agora Console, open the Projects page.

  2. Click Create New.

  3. Follow the on-screen instructions to enter a project name and use case, and check Secured mode: APP ID + Token (Recommended) as the authentication mechanism.

    configure_project

  4. Click Submit. You see the new project on the Projects page.

Get the App ID

Agora automatically assigns a unique identifier to each project, called an App ID.

To copy this App ID, find your project on the Projects page in Agora Console, and click the copy icon in the App ID column.

configure_project

Enable and configure Signaling

Before using Signaling, you need to enable it for each app ID in Agora Console and configure its main features.

Note
The following steps apply to the new version of Agora Console. If you are using the old one, switch to the new version by clicking Switch to the new version at the top of the screen.

Enable Signaling for your project

  1. Select your project on the Projects page and click the corresponding pencil icon to configure it.

    configure_project

  2. Go to All features > Signaling > Basic information and select a data center in the dropdown.

    project_settings_signaling

  3. Go to Subscriptions > Signaling and subscribe to a plan.

    signaling-pricing-page

    Once subscribed, you will be able to unsubscribe from the same page.

Configure Signaling features

  1. Go to All features > Signaling > Presence Configuration and configure the following:

    • Maximum number of instant events
    • Timed event notification interval
    • Event notification debounce time

    signaling-presence-configuration

  2. Go to All features > Signaling > Storage Configuration and toggle the following:

    • Using storage
    • User attribute callback
    • Channel attribute callback
    • Distributed lock

    signaling-storage-configuration

  3. Raise a support ticket to activate the stream channel, if necessary. The Agora support team confirms activation through a ticket update.

Security and authentication

Use the following features from your Agora account to implement security and authentication features in your apps.

Get the App Certificate

When generating an authentication token on your app server, you need an App Certificate, in addition to the App ID.

To get an App Certificate, do the following:

  1. On the Projects page, click the pencil icon to edit the project you want to use.

    Console project management page

  2. Click the copy icon under Primary Certificate.

    Console primary certificate

Generate temporary tokens

To ensure communication security, best practice is to use tokens to authenticate the users who log in from your app.

To generate a temporary RTC token for use in your Video SDK projects:

  1. On the Projects page, click the pencil icon next to your project.

  2. On the Security panel, click Generate Temp Token, enter a channel name in the pop-up box and click Generate. Copy the generated RTC token for use in your Video SDK projects.

To generate a token for other Agora products:

  1. In your browser, navigate to the Agora token builder.

  2. Choose the Agora product your user wants to log in to. Fill in App ID and App Certificate with the details of your project in Agora Console.

  3. Customize the token for each user. The required fields are visible in the Agora token builder.

    In Signaling, each authentication token you create is specific for a user ID in your app. You create a token for each user in the channel. When you call login using Signaling SDK, ensure that the UID is the same as you used to create the token.

  4. Click Generate Token.

    The token appears in Token Builder.

  5. Copy the token and use it in your app.

For more information on managing other aspects of your Agora account, see Agora console overview.

Signaling