Authenticate

The authenticate function plays a crucial role in initializing the SDK. It establishes a secure session and prepares the SDK for subsequent operations. For optimal effectiveness, follow these guidelines before invoking the function:

Authentication Integration Guide

Introduction

Ensure the core module is integrated correctly for successful authentication.

Steps

1. Verify Module Installation

   • Check that the authentication module is installed (Integrate in Android).

2. Configure Settings

   • Update configuration files with necessary credentials.

Get the API key and Secret Key from Truvideo Support

Generating a Signature

To enhance the security of your API requests, it's necessary to generate a signature if you have an API key and a Secret key. This process ensures that your requests are authenticated and can be trusted by the server. Follow these steps to generate a signature:

1. Collect Necessary Keys:

   • Ensure you have your API key and Secret key ready. These are provided when you register for access to the API.

2. Create the Signature String:

   • Combine specific parameters from your request into a single string. This usually involves the HTTP method, URL, and any query parameters or headers that are part of the request.

3. Apply Hash Function:

   • Use a cryptographic hash function like HMAC with the Secret key to hash the signature string. The specific algorithm (e.g., SHA256) will depend on the API requirements.

4. Encode the Signature:

   • The resulting hash should be encoded in base64 to form the final signature.

5. Attach the Signature to Your Request:

   • Include the generated signature in the request headers or query parameters, as stipulated by the API documentation.

By following these steps, you can ensure that each request you make is securely signed and authenticated. Always refer to the specific API documentation for detailed implementation guidelines.

Java

public String toSha256String(String key, String msg) {
   try {
  // getting instance of Message Authentication Code
       Mac hmacSha256 = Mac.getInstance("HmacSHA256");
//secretKey
       SecretKeySpec secretKey = new SecretKeySpec(key.getBytes(), "HmacSHA256");
       hmacSha256.init(secretKey);
       byte[] macData = hmacSha256.doFinal(msg.getBytes());

       // Convert byte array to hex string
       StringBuilder hexString = new StringBuilder();
       for (byte b : macData) {
           String hex = Integer.toHexString(0xff & b);
           if (hex.length() == 1) {
               hexString.append('0');
           }
           hexString.append(hex);
       }
       return hexString.toString();
   } catch (NoSuchAlgorithmException | InvalidKeyException e) {
       e.printStackTrace();
       return null;
   }
}

Kotlin

fun toSha256String(secret: String, payload: String): String? {
   return try {
       // getting instance of Message Authentication Code
       val hmacSha256 = Mac.getInstance("HmacSHA256") 
       //secretKey
       val secretKey = SecretKeySpec(secret.toByteArray(), "HmacSHA256")         
       hmacSha256.init(secretKey)
       val macData = hmacSha256.doFinal(payload.toByteArray())
       // Convert byte array to hex string
       val hexString = StringBuilder()
       for (b in macData) {
           val hex = Integer.toHexString(0xff and b.toInt())
           if (hex.length == 1) {
               hexString.append('0')
           }
           hexString.append(hex)
       }
       hexString.toString() //return encoded string
   } catch (e: NoSuchAlgorithmException) {
       e.printStackTrace()
       null
   } catch (e: InvalidKeyException) {
       e.printStackTrace()
       null
   }
}

1. Test Connection

• Run tests to confirm successful integration.

Java

public static void authenticate(){
//        TruvideoSdkCamera.getInstance().initCameraScreen(context);
    if (!isAuthenticated() || isAuthenticationExpired()) {
        // Get API key and secret key
        String apiKey = "YOUR-API-KEY"
        // generate payload for authentication
        String payload = TruvideoSdk.getInstance().generatePayload();
        String secretKey = "YOUR-SECRET-KEY"
        // generate SHA-256 hash of payload with signature as secret key
        String signature = toSha256String(secretKey,payload);
        String externalId = ""; // empty string if you don't have multitenant enabled, or the value for your sub-account
        // Authenticate user
        TruvideoSdk.getInstance().authenticate(apiKey, payload, signature,externalId,
            new TruvideoSdkCallback<>(){
                @Override
                public void onComplete(Unit unit) {
                    initialize();
                }
                @Override
                public void onError(@NonNull TruvideoSdkException e) {
                    // handle error
                }
        });
    }
    initialize();
    
}
public static void initialize() {
    TruvideoSdk.getInstance().initAuthentication(new TruvideoSdkCallback<>() {
        @Override
        public void onComplete(Unit unit) {
            // Authentication ready
        }

        @Override
        public void onError(@NonNull TruvideoSdkException e) {
            // handle error

        }
    });
}

Kotlin

try {
    // Check if user is authenticated
    val isAuthenticated = TruvideoSdk.isAuthenticated
    // Check if authentication token has expired
    val isAuthenticationExpired = TruvideoSdk.isAuthenticationExpired
    if (!isAuthenticated || isAuthenticationExpired) {
        // get API key and secret key
        val apiKey = context.resources.getString("YOUR-API-KEY")
        // generate payload for authentication
        val payload = TruvideoSdk.generatePayload()
        // get secret key
        val secretKey = context.resources.getString("YOUR-SECRET-KEY")
        // generate SHA-256 hash of payload with signature as secret key
        val signature = toSha256String(secretKey, payload)
        // Authenticate user
        TruvideoSdk.authenticate(
            apiKey = apiKey,
            payload = payload,
            signature = signature!!
        )
    }
    // If user is authenticated successfully
    TruvideoSdk.initAuthentication()

    // Authentication ready
    // Truvideo SDK its ready to be used
} catch (exception: Exception) {
    exception.printStackTrace()
    // Handle error
}

Final Steps: Test Your Integration

After implementing the authentication:

• Run your application to verify that the SDK session initializes successfully.

• Monitor the logs for any issues related to signatures or tokens.

• Once confirmed, proceed to explore media capture, uploading, and editing features.

---

Thank you for using the Truvideo SDK. You're now authenticated and ready to explore all features!