Synerise Knowledge Hub

https://hub.synerise.com
Admin
Synerise Knowledge Hub is a comprehensive documentation platform providing platform guides, API...
Tokens:2,128,240
Snippets:16,960
Trust Score:9.5
Update:1 month ago
Show doc for...
Tokens:
Raw
### Get Walkthrough Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/campaigns

Usage examples for fetching a walkthrough in Java and Kotlin.

```java
Injector.getWalkthrough();
```

```kotlin
Injector.getWalkthrough()
```

--------------------------------

### Get recommendations example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/react-native/content.md

An example of how to configure RecommendationOptions and invoke the getRecommendationsV2 method in JavaScript.

```JavaScript
let recommendationOptions = new RecommendationOptions()
recommendationOptions.productID = 'productID'
recommendationOptions.slug = 'slugName'
Synerise.Content.getRecommendationsV2(recommendationOptions, function(recommendationResponse) {
      //success
},function(error) {
      //failure
});
```

--------------------------------

### Get promotions example (SDK >= 1.0.0)

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/flutter/promotions.md

Usage example for the getPromotions method in the current SDK, demonstrating the use of onSuccess and onError callbacks.

```Dart
await Synerise.promotions.getPromotions(promotionsApiQuery, onSuccess: (PromotionResponse promotionResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });
```

--------------------------------

### Get documents example in JavaScript

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/react-native/content.md

An example demonstrating how to initialize a DocumentsApiQuery and call the getDocuments method using the Synerise SDK.

```JavaScript
let documentsApiQuery = new DocumentsApiQuery(DocumentsApiQueryType.SCHEMA, 'type', '1.0.0')
Synerise.Content.getDocuments(documentsApiQuery, function(documents) {
     //success
}, function(error) {
     //failure
 })
```

--------------------------------

### Initialize SDK usage example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/lifecycle.md

Example implementation of the initialization method using an API key and base URL.

```Swift
let apiKey = "YOUR_PROFILE_API_KEY"
let apiBaseUrl = "YOUR_API_BASE_URL"
Synerise.initialize(apiKey: apiKey, baseUrl: apiBaseUrl)
```

```Objective-C
static NSString *apiKey = @"YOUR_PROFILE_API_KEY";
static NSString *apiBaseUrl = @"YOUR_API_BASE_URL";
[SNRSynerise initializeWithApiKey:apiKey andBaseUrl:apiBaseUrl];
```

--------------------------------

### Get Promotions Usage Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/promotions.md

Example implementation of the getPromotions method in Swift and Objective-C.

```Swift
Promotions.getPromotions(success: { (promotionResponse) in
  // success
    print(promotionResponse.items)
}, failure: { (error) in
  // failure
})
```

```Objective-C
[SNRPromotions getPromotionsWithSuccess:^(SNRPromotionResponse *promotionResponse) {
    / success
} failure:^(SNRApiError *error) {
  // failure
}];
```

--------------------------------

### getRecommendations Usage Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/content.md

Example showing how to initialize the request body, set the product ID, and execute the recommendation request.

```java
RecommendationRequestBody requestBody = new RecommendationRequestBody();
requestBody.setProductId("1");
String slugName = "testSlugName";
apiCall = Content.getRecommendations(slugName, requestBody);
apiCall.execute(this::onSuccess, this::onFailure);
```

```kotlin
val requestBody = RecommendationRequestBody()
requestBody.setProductId("1")
val slugName = "testSlugName"
apiCall = Content.getRecommendations(slugName, requestBody)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

--------------------------------

### Show Walkthrough Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/campaigns

Usage examples for displaying a walkthrough in Java and Kotlin.

```java
Injector.showWalkthrough();
```

```kotlin
Injector.showWalkthrough()
```

--------------------------------

### Get account usage example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/client-account.md

Example implementation of the getAccount method showing success and failure handling.

```Swift
Client.getAccount(success: { (clientAccountInformation) in
  // success
}) { (error) in
  // failure
}
```

```Objective-C
[SNRClient getAccountWithSuccess:^(SNRClientAccountInformation *accountInformation) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}];
```

--------------------------------

### GET request with filters

Source: https://hub.synerise.com/developers/api/recommendations/filters.md

Example of a GET request to the Personalized model using a filter based on a client attribute.

```plaintext
curl --location 'https://api.synerise.com/recommendations/v2/recommend/items/users/8ae22439-f72b-4fe7-98e5-da3217215c54?filters=colors%3D%3Dclient.attributes.favoriteColor&token=98A5FC55-0000-0000-0000-98339BDECAE6'
```

--------------------------------

### Client.signIn Usage Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/client-authentication.md

Example implementation of the sign-in process, including handling existing calls and executing the request.

```Java
private IApiCall signInCall;
private void signIn(String login, String password) {
        if (signInCall != null) signInCall.cancel();
        signInCall = Client.signIn(login, password);
        signInCall.onSubscribe(() -> toggleLoading(true))
                  .execute(() -> onSignInSuccessful(login), () -> onSignInFailure());
    }
```

```Kotlin
private var signInCall: IApiCall
    private fun signIn(login: String, password: String) {
        signInCall!!.cancel()
        signInCall = Client.signIn(login, password)
        signInCall!!.onSubscribe({ toggleLoading(true) })
            .execute({ onSignInSuccessful(login) }, { onSignInFailure() })
    }
```

--------------------------------

### getAllPromotions Example (SDK >= 1.0.0)

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/flutter/promotions.md

Usage example for the current SDK version, requiring onSuccess and onError callbacks.

```Dart
await Synerise.promotions.getAllPromotions(onSuccess: (PromotionResponse promotionResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });
```

--------------------------------

### Get a Silent Command Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/campaigns

Usage examples for converting a push payload into a SilentCommand object in Java and Kotlin.

```java
SilentCommand silentCommand = Injector.getSilentCommand(payload);
```

```kotlin
var silentCommand = Injector.getSilentCommand(payload)
```

--------------------------------

### Initialization Example Swift

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/lifecycle.md

Example of initializing the Synerise SDK using an API key in Swift.

```Swift
let apiKey = "YOUR_PROFILE_API_KEY"
Synerise.initialize(apiKey: apiKey)
```

--------------------------------

### Get Inline In-App view identifier example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/campaigns

Example showing how to retrieve the identifier from an inline view instance.

```java
String identifier = inlineView.getIdentifier();
```

```kotlin
val identifier = inlineView.getIdentifier()
```

--------------------------------

### Get promotion by UUID example in Kotlin

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/promotions.md

Example usage of getPromotionByUuid to fetch promotion details and handle the response.

```kotlin
val apiCall = Promotions.getPromotionByUuid(uuid)
apiCall.execute({ response-> if (response != null)
                 {
                   val promotion = response.getPromotion()
                 } }, ({ this.showAlertError() }))
```

--------------------------------

### getRecommendationsV2 usage example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/content.md

Example implementation showing how to initialize a query and call the getRecommendationsV2 method.

```Swift
let apiQuery: RecommendationApiQuery = RecommendationApiQuery()
apiQuery.slug = "similar"
apiQuery.productID = "1"
Content.getRecommendationsV2(apiQuery: apiQuery, success: { (recommendationResponse) in
  // success
}) { (error) in
  // failure
}
```

```Objective-C
SNRRecommendationApiQuery *apiQuery = [SNRRecommendationApiQuery new];
apiQuery.slug = @"similar";
apiQuery.productID = "1";
[SNRContent getRecommendationsV2:apiQuery success:^(SNRRecommendationResponse *recommendationResponse) {
  // success
} failure:^(SNRApiError *error) {
  // failure
}]
```

--------------------------------

### Get promotion by UUID example in Java

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/promotions.md

Example usage of getPromotionByUuid to fetch promotion details and handle the response.

```java
IDataApiCall<SinglePromotionResponse> apiCall = Promotions.getPromotionByUuid(uuid);
        apiCall.execute(response -> {
            if (response != null) {
                Promotion promotion = response.getPromotion();
            }
        }, this::showAlertError);
```

--------------------------------

### Run Example App Commands

Source: https://hub.synerise.com/developers/mobile-sdk/installation-and-configuration/flutter.md

Commands to install dependencies, update iOS pods, and run the example application.

```bash
flutter pub get
pod update
cd example
flutter run
```

--------------------------------

### Example usage of getRecommendationsV2

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/content.md

Demonstrates how to initialize a RecommendationRequestBody, set a product ID, and execute the recommendation request.

```java
RecommendationRequestBody requestBody = new RecommendationRequestBody();
requestBody.setProductId("1");
String slugName = "testSlugName";
apiCall = Content.getRecommendationsV2(slugName, requestBody);
apiCall.execute(this::onSuccess, this::onFailure);
```

```kotlin
val requestBody = RecommendationRequestBody()
requestBody.setProductId("1")
val slugName = "testSlugName"
apiCall = Content.getRecommendationsV2(slugName, requestBody)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

--------------------------------

### JavaScript Example for activatePromotionsBatch

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/react-native/promotions.md

Usage example for activating promotions in a batch using the Synerise SDK.

```JavaScript
Synerise.Promotions.activatePromotionsBatch(promotionsIdentifiers, function() {
    //success
}, function(error) {
    //failure
});
```

--------------------------------

### GET request with JavaScript XHR

Source: https://hub.synerise.com/developers/api/recommendations/request.md

This example shows how to perform a GET request using XMLHttpRequest with basic error handling for the response status.

```javascript
var xhr = new XMLHttpRequest();

// Add an event listener for 'readystatechange' to handle the response
xhr.addEventListener("readystatechange", function() {
  if(this.readyState === XMLHttpRequest.DONE) {
    if (this.status >= 200 && this.status < 300) {
      // Successful response
      console.log(this.responseText);
    } else {
      // Handle errors
      console.error('Request failed with status:', this.status, 'and response:', this.responseText);
    }
  }
});

// Open a GET request
xhr.open("GET", "https://api.synerise.com/recommendations/v2/recommend/campaigns/DkhvrZoTKthD?token=98A5FC55-0000-0000-0000-98339BDECAE6&clientUUID=cf9e9b57-7776-51bc-b7bc-75cc75abdf59", true);

// Send the request
xhr.send();
```

--------------------------------

### Register Customer Account Example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/react-native/client-authentication.md

Example of registering a customer with email, password, and additional profile data.

```JavaScript
let email = "EMAIL";
let password = "PASSWORD";

let context = new ClientAccountRegisterContext(email, password);
context.phone = '123456789';
context.customId = '000111';

context.firstName = 'John';
context.lastName = 'Rise';
context.sex = ClientSex.Male;

context.company = 'Synerise';
context.address = 'Marszałkowska';
context.city = 'Warszawa';
context.province = 'Mazowieckie';
context.zipCode = '00-000';
context.countryCode = 'PL';

context.agreements = new ClientAgreements({
    email: true,
    sms: false,
    push: true,
    bluetooth: false,
    rfid: true,
    wifi: false
});

context.attributes = { ATTRIBUTE_1: 'ATTRIBUTE_1' }
context.tags = ['TAG_1', 'TAG_2']

Synerise.Client.registerAccount(context, function() {
  // success
}, function(error) {
  // failure
});
```

--------------------------------

### GET request with cURL

Source: https://hub.synerise.com/developers/api/recommendations/request.md

This example demonstrates a GET request where item context is passed via multiple itemId attributes in the query string.

```plaintext
curl --location 'https://api.synerise.com/recommendations/v2/recommend/campaigns/DkhvrZoTKthD?itemId=0196499479257&itemId=0000301448594&itemId=0000301826378&token=98A5FC55-0000-0000-0000-98339BDECAE6&clientUUID=cf9e9b57-7776-51bc-b7bc-75cc75abdf59'
```

--------------------------------

### Client.confirmAccountActivation usage example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/client-authentication.md

Example showing how to execute the account confirmation request and handle callbacks.

```java
private IApiCall call;
if (call != null) call.cancel();
            call = Client.confirmAccountActivation(token);
            call.execute(this::onSuccess, this::onError);
```

```kotlin
private val call: IApiCall? = null
            call.cancel();
            call = Client.confirmAccountActivation(token);
            call.execute(this::onSuccess, this::onError);
```

--------------------------------

### Client.registerAccount usage example

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/client-authentication.md

Example implementation showing how to call registerAccount, including handling existing calls and managing loading states.

```Java
private IApiCall signUpCall;
private void signUp(RegisterClient registerClient) {
        if (signUpCall != null) signUpCall.cancel();
        signUpCall = Client.registerAccount(registerClient);
        signUpCall.onSubscribe(() -> toggleLoading(true))
                  .doFinally(() -> toggleLoading(false))
                  .execute(this::onSignUpSuccessful, this::onSignUpFailure);
    }
```

```Kotlin
private var signUpCall: IApiCall
    private fun signUp(registerClient: RegisterClient) {
        signUpCall!!.cancel()
        signUpCall = Client.registerAccount(registerClient)
        signUpCall!!.onSubscribe({ toggleLoading(true) })
            .doFinally({ toggleLoading(false) })
            .execute(({ this.onSignUpSuccessful() }), ({ this.onSignUpFailure() }))
    }
```

--------------------------------

### Get promotions example (Legacy SDK)

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/flutter/promotions.md

Usage example for the getPromotions method in the legacy SDK, utilizing the catchError method for error handling.

```Dart
await Synerise.promotions.getPromotions(promotionsApiQuery).catchError((error) {
      //onError handling
    });
```

--------------------------------

### Example usage of confirmAccountActivationByPin

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/android/client-authentication.md

Implementation example showing how to execute the account activation request and handle success or failure callbacks.

```Java
IApiCall apiCall;
apiCall = Client.confirmAccountActivationByPin(pinCode, email);
apiCall.execute(this::onSuccess, this::onFailure);
```

```Kotlin
val apiCall:IApiCall
apiCall = Client.confirmAccountActivationByPin(pinCode, email)
apiCall.execute(({ this.onSuccess() }), ({ this.onFailure() }))
```

--------------------------------

### Get Assigned Voucher Codes Example (Legacy SDK)

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/flutter/promotions.md

Usage example for the legacy SDK version, utilizing the catchError method for error handling.

```Dart
await Synerise.promotions.getAssignedVoucherCodes().catchError((error) {
      //onError handling
    });
```

--------------------------------

### Show Walkthrough Method

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/ios/campaigns.md

Displays a walkthrough once it has been loaded.

```Swift
static func showWalkthrough() -> Void
```

```Objective-C
+ (void)showWalkthrough
```

--------------------------------

### Get Assigned Voucher Codes Example (SDK >= 1.0.0)

Source: https://hub.synerise.com/developers/mobile-sdk/method-reference/flutter/promotions.md

Usage example for the current SDK version, implementing the required onSuccess and onError callbacks.

```Dart
await Synerise.promotions.getAssignedVoucherCodes(onSuccess: (VoucherCodesResponse voucherCodesResponse) {
      //onSuccess handling
    }, onError: (SyneriseError error) {
      //onError handling
    });
```
Tokens:
Raw