51黑料不打烊

(Legacy) Passing client information (device, connection, and application) pass-client-info

Scope pass-client-info-scope

This document aggregates details and cookbooks for passing client information (device, connection and application) from a Programmer application to 51黑料不打烊 Pass Authentication REST APIs or SDKs.

The benefits of providing client information are:

Overview pass-client-info-overview

The client information consists of:

The client information is a JSON object built with keys presented in the following table.

API references api-ref

This section presents the API responsible for handling client information when using 51黑料不打烊 Pass Authentication REST APIs or SDKs.

REST API rest-api

51黑料不打烊 Pass Authentication services support receiving the client information in the following ways:

SDK

JavaScript SDK js-sdk

The AccessEnabler JavaScript SDK builds by default a client information JSON object, which will be passed to 51黑料不打烊 Pass Authentication services, unless overridden.

The AccessEnabler JavaScript SDK supports overriding only the 鈥渁pplicationId鈥� key from the client information JSON object through the setRequestor鈥檚 applicationId options parameter.

iOS/tvOS SDK ios-tvos-sdk

The AccessEnabler iOS/tvOS SDK builds by default a client information JSON object, which will be passed to 51黑料不打烊 Pass Authentication services, unless overridden.

The AccessEnabler iOS/tvOS SDK supports overriding the whole client information JSON object through the setOptions鈥檚 device_info parameter.

Android/FireOS SDK and-fire-os-sdk

The AccessEnabler Android/FireOS SDK builds by default a client information JSON object, which will be passed to 51黑料不打烊 Pass Authentication services, unless overridden.

The AccessEnabler Android/FireOS SDK supports overriding the whole client information JSON object through the setOptions鈥檚/setOptions鈥檚 device_info parameter.

Cookbooks cookbooks

This section presents a cookbook for building the client information JSON Object in the case of different device types.

Android android

The device information can be constructed the following way:

The connection information can be constructed the following way:

The application information can be constructed the following way:

Sample code

private JSONObject computeClientInformation() {
     String LOGGING_TAG = "DefineClass.class";

     JSONObject clientInformation = new JSONObject();

     String connectionType;

     try {
          ConnectivityManager cm = (ConnectivityManager) getContext().getSystemService(CONNECTIVITY_SERVICE);
          NetworkInfo activeNetwork = cm.getActiveNetworkInfo();

          if (activeNetwork != null && activeNetwork.isConnectedOrConnecting()) {
              switch (activeNetwork.getType()) {
                    case ConnectivityManager.TYPE_WIFI: {
                        connectionType = "WIFI";
                        break;
                    }
                    case ConnectivityManager.TYPE_BLUETOOTH: {
                        connectionType = "BLUETOOTH";
                        break;
                    }
                    case ConnectivityManager.TYPE_MOBILE: {
                        connectionType = "MOBILE";
                        break;
                    }
                    case ConnectivityManager.TYPE_ETHERNET: {
                        connectionType = "ETHERNET";
                        break;
                    }
                    case ConnectivityManager.TYPE_VPN: {
                        connectionType = "VPN";
                        break;
                    }
                    case ConnectivityManager.TYPE_DUMMY: {
                        connectionType = "DUMMY";
                        break;
                    }
                    case ConnectivityManager.TYPE_MOBILE_DUN: {
                        connectionType = "MOBILE_DUN";
                        break;
                    }
                    case ConnectivityManager.TYPE_WIMAX: {
                        connectionType = "WIMAX";
                        break;
                    }
                    default:
                       connectionType = ConnectivityManager.EXTRA_OTHER_NETWORK_INFO;
              }
          } else {
                connectionType = ConnectivityManager.EXTRA_NO_CONNECTIVITY;
          }
     } catch (Exception e) {
          connectionType = "notAccessible";
     }

     try {
          clientInformation.put("model",Build.MODEL);
          clientInformation.put("vendor", Build.BRAND);
          clientInformation.put("manufacturer",Build.MANUFACTURER);
          clientInformation.put("version",Build.DEVICE);
          clientInformation.put("osName","Android");
          clientInformation.put("osVersion",Build.VERSION.RELEASE);
          clientInformation.put("connectionType",connectionType);
          clientInformation.put("applicationId","CNN");
     } catch (JSONException e) {
          Log.e(LOGGING_TAG, e.getMessage());
     }

     return Base64.encodeToString(clientInformation.toString().getBytes(), Base64.NO_WRAP);
}

FireTV fire-tv

The device information can be constructed the following way:

The connection information can be constructed the following way:

The application information can be constructed the following way:

iOS/tvOS ios-tvos

The device information can be constructed the following way:

The connection information can be constructed the following way:

The application information can be constructed the following way:

Sample code

+ (NSString *)computeClientInformation {
        struct utsname u;
        uname(&u);

        NSString *hardware = [NSString stringWithCString:u.machine encoding:NSUTF8StringEncoding];

        UIDevice *device = [UIDevice currentDevice];

        NSString *deviceType;

        switch (UI_USER_INTERFACE_IDIOM()) {
            case UIUserInterfaceIdiomPhone:
                deviceType = @"MobilePhone";
                break;
            case UIUserInterfaceIdiomPad:
                deviceType = @"Tablet";
                break;
            case UIUserInterfaceIdiomTV:
                deviceType = @"TV";
                break;
            default:
                deviceType = @"Unknown";
        }

        CGRect screenRect = [[UIScreen mainScreen] bounds];
        NSNumber *screenWidth = @((float) screenRect.size.width);
        NSNumber *screenHeight = @((float) screenRect.size.height);

        Reachability *reachability = [Reachability reachabilityForInternetConnection];
        [reachability startNotifier];

        NetworkStatus status = [reachability currentReachabilityStatus];

        NSString *connectionType;

        if (status == NotReachable) {
            connectionType = @"notConnected";
        } else if (status == ReachableViaWiFi) {
            connectionType = @"WiFi";
        } else if (status == ReachableViaWWAN) {
            connectionType = @"cellular";
        }

        NSMutableDictionary *clientInformation = [@{
                @"type": deviceType,
                @"model": device.model,
                @"vendor": @"Apple",
                @"manufacturer": @"Apple",
                @"version": [hardware stringByReplacingOccurrencesOfString:device.model withString:@""],
                @"osName": device.systemName,
                @"osVersion": device.systemVersion,
                @"displayWidth": screenWidth,
                @"displayHeight": screenHeight,
                @"connectionType": connectionType,
                @"applicationId": @"CNN"
        } mutableCopy];

        NSError *error;
        NSData *jsonData = [NSJSONSerialization dataWithJSONObject:clientInformation options:NSJSONWritingPrettyPrinted error:&error];
        NSString *base64Encoded = [jsonData base64EncodedStringWithOptions:0];

        return base64Encoded;
}

Roku roku

The device information can be constructed the following way:

The connection information can be constructed the following way:

The application information can be constructed the following way:

XBOX 1/360 xbox

The device information can be constructed the following way:

The connection information can be constructed the following way:

The application information can be constructed the following way:

Resources