Integrate the Site Reputation SDK

Integrate the Site Reputation SDK into your application

Prerequisites

1. Complete the Getting Started Guide

2. Integrate the User SDK

Get Started

• Integrate the JS SDK

• Integrate the iOS SDK

• Integrate the Android SDK

Integrate the JS SDK

Add @sudoplatform/sudo-site-reputation as a dependency to your project.

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

In order to instantiate a Site Reputation client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above).

To instantiate a client in your application, add the following:

TypeScript

import { SudoSiteReputationClient } from '@sudoplatform/sudo-site-reputation'
import { DefaultSudoUserClient } from '@sudoplatform/sudo-user'

// See User SDK docs
const sudoUserClient = new DefaultSudoUserClient()

const siteReputationClient = new SudoSiteReputationClient({
  sudoUserClient, 
})

Integrate the iOS SDK

Add this line to your Podfile:

pod 'SudoSiteReputation'

Install pod dependencies by running the following command in your project directory:

pod install --repo-update

This will update the local CocoaPods repository and install the latest version of the Site Reputation SDK.

In order to instantiate a Site Reputation client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above).

To instantiate a client in your application, add the following:

Swift

import SudoUser
import SudoSiteReputation

let userClient: SudoUserClient = // ... see "Users" docs
let siteReputationClient = try DefaultSudoSiteReputationClient(
    userClient: userClient
)

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.

See it in action. Be sure to take a look at the open-source iOS sample app on GitHub that our team published as a reference for integrating the Sudo Site Reputation SDK into your app as quickly and seamlessly as possible.

Integrate the Android SDK

Add this line to the dependencies section of the app module build.gradle and run Gradle sync.

dependencies {
    api 'com.sudoplatform:sudositereputation:2.0.0'
}

In order to instantiate a Site Reputation client, make sure you have followed instructions for Getting Started and User SDK (see Prerequisites above).

To instantiate a client in your application, add the following:

Kotlin

val userClient: SudoUserClient = // ... see "Users" docs

val sudoSiteReputationClient = SudoSiteReputationClient.builder()
            .setContext(this)
            .setSudoUserClient(sudoUserClient)
            .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.

See it in action. Be sure to take a look at the open source Android sample app on GitHub that our team published as a reference for integrating the Sudo Site Reputation SDK into your app as quickly and seamlessly as possible.