iOS SDK - Search and Category APIs

Setup

To set up the SDK before using, complete the following steps:

Add the package

If you have already integrated the Pixel SDK, there is no need to add any additional packages.

If not, you can follow the steps given here to add the package.

Initialization

To initialize the Discovery Pixel SDK in your app, first import the discovery_ios_sdk module in your UIApplicationDelegate:

import discovery_ios_sdk

Then initialize the API Discovery SDK (brApiRequest) in your app delegate's application(_:didFinishLaunchingWithOptions:) method as shown:

class AppDelegate: NSObject, UIApplicationDelegate {
  func application(_ application: UIApplication, didFinishLaunchingWithOptions launchOptions: [UIApplication.LaunchOptionsKey : Any]? = nil) -> Bool {
  //...
  //...
    
//Initialise API 
    let brApiRequest = BrApiRequest(
      accountId: "<ACCOUNT_ID>",
      uuid: "<13_digit_random_number>",
      visitorType: VisitorType.NEW_USER,
      domainKey: "documentation_site",
      environment: Env.PROD)
        
    BrApi.shared.intialise(brApiRequest: brApiRequest)

 	  return true
  }
}

If you are using SwiftUI, use the UIApplicationDelegateAdaptor property wrapper to tell SwiftUI it should use your AppDelegate class for the application delegate.

@main
struct MyApp: App {
    @UIApplicationDelegateAdaptor(AppDelegate.self) var appDelegate

    var body: some Scene {
        WindowGroup {
            ContentView()
        }
    }
}

Make sure to replace all the placeholder values for the parameter values in the snippet above.


Here is a reference of all the different parameters you can set based on your requirements:

Triggering the APIs

Note: Import the discovery_ios_sdk module on the files where you need to trigger APIs.

Product Search API

Create the object of ProductSearchRequest for the request parameter to be passed to the Product Search API with different types of fields supported.

let productSearchRequest = ProductSearchRequest()
  .searchTerm(q: "table")
  .fl(value: "pid")
  .url(value: "example.com")

Then call the productSearchApi method in BrApi, and pass the request object along with the completion handler instance. The results get captured in the callback method as either success or failure.

BrApi.shared.productSearchApi(productSearchRequest: productSearchRequest) { response in
	//gets required response in response object
  } failure: { error in
      // if the API fails, handle error here.
  }

Supported parameters for creating the ProductSearchRequest object:

BOPIS

Category Search API

Create the object of CategorySearchRequest for the request parameter to be passed to the Category search API with different types of fields supported.

let categorySearchRequest = CategorySearchRequest()
  .fl(values: 
    [
      "pid",
      "title",
      "brand",
      "price"
    ]
  )
  .searchTerm(q: "test")

Then, call the categorySearchApi method in BrApi, and pass the request object along with the completion handler instance. The results gets captured in callback method as either success or failure.

BrApi.shared.categorySearchApi(categorySearchRequest: productSearchRequest) { response in
	//gets required response in response object
    } failure: { error in
   	    // if the API fails, handle error here.
    }

Note: The Parameters for creating the object are same as the ones mentioned in Product Search API above.

Content Search API

Create the object of ContentSearchRequest for the request parameter to be passed to the Content search API with different types of fields supported.

let contentSearchRequest = ContentSearchRequest()
  .fl(
    values: [
      "pid",
      "title",
      "brand",
      "price"
    ]
  )
  .catalogName(value: "Chair")
  .searchTerm(q: "test")

Then, call the contentSearchApi method in BrApi, and pass the request object along with the completion handler instance. The results get captured in the callback method as either success or failure.

BrApi.shared.contentSearchApi(contentSearchRequest: contentSearchRequest) { response in
  //gets required response in response object
    } failure: { error in
   	  // if the API fails, handle error here.
    }

Supported parameters for creating the ContentSearchRequest object:

Note: Rest of the parameters for creating the object are same as the ones mentioned in Product Search API above.

Bestseller API

Create the object of BestSellerRequest for the request parameter to be passed to the BestSeller API with different types of fields supported.

let bestSellerRequest = BestSellerRequest()
  .fl(
    istOf(
      "pid",
      "title",
      "brand",
      "price"
    )
    )
    .searchTerm("test")

Then, call the bestSellerApi method in BrApi, and pass the request object along with the completion handler instance. The results get captured in the callback method as either success or failure.

BrApi.shared.bestSellerApi(bestSellerRequest: bestSellerRequest) { response in
  //gets required response in response object
    } failure: { error in
   	  // if the API fails, handle error here.
    }

Supported parameters for creating the BestSellerRequest object:

Note: Rest of the parameters for creating the object are same as the ones mentioned in Product Search API above.

Autosuggest API

Create the object of AutosuggestRequest for the request parameter to be passed to the Autosuggest API with different types of fields supported.

let autoSuggestRequest = AutosuggestRequest()
  .catalogViews(value: “product:store1|p1:s1”)

Then, call the autoSuggestApi method in BrApi, and pass the request object along with the completion handler instance. The results get captured in the callback method as either success or failure.

BrApi.shared.autoSuggestApi(autoSuggestApi: autoSuggestApi) { response in
  //gets required response in response object
    } failure: { error in
      // if the API fails, handle error here.
    }

Supported parameters for creating the AutosuggestRequest object: