Close Menu

mobile-buy-sdk

Introduction

Welcome to the documentation for the Mobile Buy SDK, a powerful toolkit that allows developers to easily incorporate Shopify functionality into their mobile apps. With this SDK, you can connect your app directly to a Shopify store, giving your users the ability to browse and buy products, manage their cart, and checkout seamlessly.

In this comprehensive guide, you will find all the information you need to get started with the Mobile Buy SDK, from installation and configuration to understanding the key features and best practices for implementation. Let’s dive in!

Installation

To begin using the Mobile Buy SDK in your app, you need to install it as a dependency. Follow these steps to install the SDK:

  1. Open your project in Xcode (or the IDE of your choice) and navigate to the Podfile located in the root directory.
  2. Add the following line to your Podfile:

pod 'Mobile-Buy-SDK'

  1. Save the file and run pod install in your terminal to install the SDK.
  2. Once the installation is complete, open your app’s workspace and import the SDK module.

Configuration

Before you can start using the Mobile Buy SDK in your app, you need to configure it with your Shopify store credentials. Follow these steps to configure the SDK:

  1. Obtain your Shopify store’s domain, API key, and storefront access token.
  2. In your app’s code, locate the place where you want to configure the SDK. Typically, this would be in your app’s setup or initialization code.
  3. Call the topLevelConfig(userDomain: apiKey: accessToken:) method on the BUYClient class, passing in your Shopify store credentials.



import MobileBuySDK

let client = BUYClient()
client.topLevelConfig(userDomain: "your-shopify-store.myshopify.com", apiKey: "your-api-key", accessToken: "your-storefront-access-token")

Key Features

The Mobile Buy SDK offers a wide range of features that enable you to create a complete shopping experience within your app. Here are some of the key features:

  • Product Retrieval: Fetch detailed product information, including images, pricing, variants, and metadata.
  • Product Listing: Display a collection of products, allow users to browse and filter products based on various criteria.
  • Cart Management: Provide users with the ability to add products to a cart, manage quantities, and apply discounts.
  • Checkout: Enable users to complete the purchasing process within your app, including address selection, shipping options, and payment methods.
  • Localization: Support multiple languages and currencies to ensure a localized experience for your users.
  • Webhooks: Configure webhooks to receive real-time updates on product changes, order fulfillment, and more.

Best Practices

To make the most out of the Mobile Buy SDK, consider the following best practices:

  • Optimize Performance: Implement caching and lazy loading techniques to improve app performance and reduce network requests.
  • Error Handling: Handle API errors gracefully and provide appropriate feedback to your users in case of failures.
  • Security: Keep your Shopify store credentials secure by using secure storage mechanisms or encryption.
  • Testing: Thoroughly test your implemented features, including edge cases, to ensure a reliable and bug-free shopping experience.
  • Documentation: Document your API integrations and SDK usage for future reference and collaboration with other team members.

Conclusion

Congratulations! You now have a solid understanding of the Mobile Buy SDK and how it can be integrated into your mobile app. By following the installation and configuration steps, exploring the key features, and incorporating best practices, you are well-equipped to create a seamless and immersive shopping experience for your users. Happy coding!