API QoD Home Devices| Telefónica Open Gateway

Empieza a incorporar las capacidades telco en tus aplicaciones, implementando un caso de uso extremo a extremo. Te ofrecemos un SDK de JavaScript para la API de QoD de un agregador simulado, pero completamente funcional en las líneas de Movistar en España.

Para utilizar esta API sólo tienes que llamar a los métodos que ofrecen las clases MobileNetwork o HomeNetwork del SDK correspondiente al lenguaje de programación que utilices en tu backend. Te recomendamos que uses el SDK desde tu backend, siempre que la arquitectura de tu aplicación lo permita.

En el siguiente ejemplo te mostramos cómo asignar una calidad de servicio adecuada para el uso de aplicaciones de comunicación en tiempo real a uno de los dispositivos conectados a la red WiFi.

Primero, instancia la clase HomeNetwork proporcionando las credenciales que te hayan facilitado desde el registro en el Early Adopter Program de Open Gateway y la dirección IP pública del router en cuya WiFi queramos realizar la asignación.

                                
// Declare your app’s client credentials as provided on your app’s registration
const appCredentials: ClientCredentials = {
    clientId: 'your-app-client-id', // Tip: as from your settings file, i.e. .env
    clientSecret: '9999-9999999-999999-99999',
};

// Implement a function that gets your user’s home network public IP
// by taking it from your frontend’s http request header
const homePublicIp: string = getClientIp();

// Instantiate a HomeNetwork QoD API client to use it below
const homeNetwork = new HomeNetwork(appCredentials, homePublicIp);

                                
# Declare your app's client credentials as provided on your app's registration
app_credentials = {
    'client_id': 'your-app-client-id', # Tip: as from your settings file, i.e. .env
    'client_secret': '9999-9999999-999999-99999',
}

# Implement a function that gets your user’s home network public IP
# by taking it from your frontend’s http request header
home_public_ip = get_client_ip()

# Instantiate a HomeNetwork QoD API client to use it below
home_network = HomeNetwork(app_credentials, home_public_ip)

                                
// Declare your app’s client credentials as provided on your app’s registration
Map<String, String> appCredentials = new HashMap<String, String>();
appCredentials.put("clientId", "your-app-client-id");  // Tip: as from your settings file, i.e. .env
appCredentials.put("clientSecret", "9999-9999999-999999-99999");

// Implement a function that gets your user’s home network public IP
// by taking it from your frontend’s http request header
String homePublicIp = getClientIp();

// Instantiate a HomeNetwork QoD API client to use it below
HomeNetwork homeNetwork = new HomeNetwork(appCredentials, homePublicIp);

                                
// Declare the app's client credentials as provided on the app's registration
var appCredentials ClientCredentials
appCredentials.clientID = "your-app-client-id"
appCredentials.clientSecret = "9999-9999999-999999-99999"

// Implement a function that gets your user's home network public IP
// by taking it from your frontend's http request header
var homePublicIP string
homePublicIP = getClientIP()

// Instantiate a HomeNetwork QoD API client to use it below
var homeNetwork HomeNetwork
homeNetwork = *NewHomeNetwork(appCredentials, homePublicIP)

Para terminar, identifica, mediante su IP local, el dispositivo conectado a WiFi al que quieras asignar la calidad de servicio, y utiliza el método setQualityOfService de la clase HomeNetwork pasando como parámetros el dispositivo y la clasificación de calidad de servicio deseada.

                                
// Implement a function that gets the local IP of the device your user wants to assign a quality of service classification
// by taking it from your frontend’s http request body payload
const deviceIp: string = getDeviceLocalIp();
const device: HomeDevice = {
    localIpAddress: deviceIp
};

// Call your HomeNetwork QoD API client instance’s set QoS function
// with the desired NetworkQoSClassification
homeNetwork.setQualityOfService(device, NetworkQoSClassification.RealTimeInteractive);

                                
# Implement a function that gets the local IP of the device your user wants to assign a quality of service classification
# by taking it from your frontend’s http request body payload
device_ip = get_device_local_ip()
device = {
    'local_ip_address': device_ip
}

# Call your HomeNetwork QoD API client instance’s set QoS function
# with the desired NetworkQoSClassification
home_network.set_quality_of_service(device, NetworkQoSClassification.RealTimeInteractive)

                                
// Implement a function that gets the local IP of the device your user wants to assign a quality of service classification
// by taking it from your frontend’s http request body payload
String deviceIp = getDeviceLocalIp();
HomeDevice device = new HomeDevice(deviceIp);

// Call your HomeNetwork QoD API client instance’s set QoS function
// with the desired NetworkQoSClassification
homeNetwork.setQualityOfService(device, NetworkQoSClassification.RealTimeInteractive);

                                
// Implement a function that gets the local IP of the device your user wants to assign a quality of service classification
// by taking it from your frontend’s http request body payload
deviceIp := getDeviceLocalIp()
device := HomeDevice{
    LocalIpAddress: deviceIp,
}

// Call your HomeNetwork QoD API client instance’s set QoS function
// with the desired NetworkQoSClassification
homeNetwork.SetQualityOfService(device, RealTimeInteractive)

Empieza a utilizar esta API realizando una solicitud de inscripción en nuestro Early Adopter Program. Una vez inscrito, podrás encontrar las instrucciones de instalación y un proyecto completo de ejemplo en JavaScript en nuestro repositorio en GitHub.

API QoD WiFi