Integrate the Sudo Profiles SDK

Integrate the Sudo Profiles SDK into your application

Prerequisites

  1. Complete the Getting Started Guide

  2. Integrate the User SDK

Get Started

Integrate the iOS SDK

To use Sudo Profiles SDK in an iOS app, you need to install the SudoProfiles package via Swift Package Manager

Open your project settings in XCode, and go to the Package Dependencies tab. Click on the + sign to add a dependency.

Enter the repository URL https://github.com/sudoplatform/sudo-profiles-ios in the top right search box and select the sudo-profiles-ios repository.

Select the required version and Add Package.

Sudo Platform SDKs conform to semantic versioning so in most cases you will leave the Dependency Rule as Up to Next Major Version to receive regular updates without introducing any breaking changes.

This will resolve the local package dependency and install the latest version of the Sudo Profiles SDK.

Instantiating and initializing a client:

do {
    let client: SudoProfilesClient = try DefaultSudoProfilesClient(sudoUserClient: sudoUserClient)
} catch {
    // Handle initialization error. An error might be thrown due to invalid
    // or missing confiugration file.
}

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Integrate the Android SDK

To use Sudo Profiles SDK in an Android app you need to add SudoProfiles library as a dependency to your project.

Edit the app module Gradle script (build.gradle) and add SudoProfiles library as a dependency.

dependencies {
    api 'com.sudoplatform:sudoprofiles:$latest_version'
}

The latest version of the SDK can be found at SDK Releases.

Edit AndroidManifest.xml to add the following app permissions:

 <?xml version="1.0" encoding="utf-8"?>
 <manifest xmlns:android="http://schemas.android.com/apk/res/android"
+   xmlns:tools="http://schemas.android.com/tools"
    package="com.sudoplatform.sampleapp">

+   <uses-permission android:name="android.permission.INTERNET" />
+   <uses-permission android:name="android.permission.ACCESS_NETWORK_STATE" />
+   <uses-permission android:name="android.permission.WAKE_LOCK" />
+   <uses-permission android:name="android.permission.READ_PHONE_STATE" />
+   <uses-permission android:name="android.permission.WRITE_EXTERNAL_STORAGE" />
+   <uses-permission android:name="android.permission.READ_EXTERNAL_STORAGE" />

    <application
+       tools:replace="android:allowBackup"
+       android:allowBackup="false"

Instantiating and initializing a client:

val client = SudoProfilesClient
            .builder(appContext, sudoUserClient, blobContainerUri)
            .build()

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Integrate the JS SDK

To use the Sudo Profiles SDK in a JS project you must add @sudoplatform/sudo-profiles as a dependency to your project

yarn add '@sudoplatform/sudo-profiles'
# or
npm install --save '@sudoplatform/sudo-profiles'

Instantiating and initializing a Sudo Profiles client:

import {
  DefaultSudoProfilesClient,
} from '@sudoplatform/sudo-profiles'

// Instantiate and initialize the client
const sudoProfilesClient = new DefaultSudoProfilesClient({
  sudoUserClient: sudoUserClient,
})

You only need one client instance for a given user per device. Instantiating multiple clients with the same configuration and using them at the same time may cause unexpected runtime errors to occur.

Symmetric Key Management for JS SDK

Symmetric keys are used in Sudo Profiles JS SDK to encrypt and decrypt Sudo claims. These keys are not stored within our system and need to be loaded into the Sudo Profile Client to be able to encrypt and decrypt your Sudo claims data. These symmetric keys can also be rotated, therefore a potential list of keys will need to be set. The storage and management of these keys will also be the responsibility of the consumer of the Sudo Profiles JS SDK.

Adding Symmetric keys to Sudo Profiles Client:

sudoProfilesClient.pushSymmetricKey('1234', '14A9B3C3540142A11E70ACBB1BD8969F')

Symmetric keys are loaded into the Sudo Profiles Client after the client has been instantiated and initialized. Any old keys that have been used in the past to encrypt Sudo claims will also need to be set so that those Sudo claims can be decrypted. The last key loaded will be set as the current key for encrypting and decrypting new Sudo claims.

It is a requirement that the Sudo Profiles Client be loaded with at least one symmetric key.

PreviousSudosNextSudo Entitlements

Last updated