Provision your extension

When your extension is activated or deactivated on Agora Console, Agora passes relevant information to you so that you can take corresponding actions. For this purpose, you need to implement the provisioning API and provide the URLs to Agora.

This page provides a detailed description of the provisioning API.

Requirements

Before implementing the provisioning API, ensure that your server meets the following requirements:

• Able to handle at least 100 requests per second.
• Follows the standards of HTTP request and response.

Agora waits for 500 milliseconds after sending a request to your server. If there is no response, Agora resends the request for a maximum of two times.

Create an account

When a user activates your extension, Agora calls this method to pass the basic information of this user to you. You can manage users by forming a user information mapping for services such as usage query.

HTTP request

URL

POST https://{host}/customers/new

Request body The request body contains the following fields:

HTTP response

The response body contains the following fields:

Example

Request body

{
    "planId": "ABC",
    "customerName": "AgoraCustomerA",
    "customerId": "12345678910",
    "customerEmail": "AgoraCustomerA",
    "customerPhone": "12345678910",
    "apiKey": "pz**************************gd",
    "signature": "Q7**************************xM"
}

Response body

{
    "status": "success",
    "statusReason": ""
}

Create a project

When a user enables your extension for an Agora project, Agora calls this method to pass the project information to you.

HTTP request

URL

POST https://{host}/customers/{customerId}/projects/new

Path parameter

customerId: String. The account ID of the user on Agora Console.

Request body The request body contains the following fields:

HTTP response

The response body contains the following fields:

Example

Request body

{
    "projectId": 5****8,
    "apiKey": "pz**************************gd",
    "signature": "Q7**************************xM"
}

Response body

{
    "status": "success",
    "statusReason": "",
    "data": {
        "appKey": "cf**************************yb",
        "appSecret": "NW**************************M=",
        "licenseUrl": "https://*********"
    }
}

Deactivate the account

Once the user deactivates your extension on Agora Console, Agora calls this method to notify you to delete the user's account and stop providing any relevant service.

HTTP request

URL

PUT http://{host}/customers/{customerId}/deactivate

Path parameter customerId: String. The ID of the user on Agora Console.

Request body The request body contains the following fields:

HTTP response

The response body contains the following fields:

Example

Request body

{
    "apiKey": "pz**************************gd",
    "signature": "Q7**************************xM"
}

Response body

{
    "status": "success",
    "statusReason": ""
}

Deactivate the project

Once the user disables your extension for an Agora project, Agora calls this method to pass the project information to you.

HTTP request

URL

PUT http://{host}//customers/{customerId}/projects/{projectId}/deactivate

Path parameter

Request body The request body contains the following fields:

HTTP response

The response body contains the following fields:

Example

Request body

{
    "apiKey": "pz**************************gd",
    "signature": "Q7**************************xM"
}

Response body

{
    "status": "success",
    "statusReason": ""
}