This is a framework for interacting with the ShopGun APIs from within your own apps. The SDK has been split into several components:
||A view for fetching, rendering, and interacting with, a catalog.|
||A view controller for fetching, rendering, and interacting with, a digital catalog (an "Incito").|
||Simplifies auth & communication with the ShopGun REST API.|
||An interface for easily making requests to ShopGun's GraphQL API.|
||An events tracker for efficiently sending analytics events.|
- iOS 9.3+
- Xcode 9.0+
- Swift 4.2+
The preferred way to install the
ShopGunSDK framework into your own app is using CocoaPods. Add the following to your
For more detailed instructions, see the Installation guide.
The repo uses a swift playground to demonstrate example uses of the components.
- Download/checkout this repo.
- Make sure you recursively checkout all the submodules in the
- Open the
ShopGunSDK.xcodeproj, and build the ShopGunSDK scheme (using a simulator destination)
- Open the
ShopGunSDK.playgroundthat is referenced inside the project. From here, you will be able experiment with the SDK.
Note: In order to use the components properly they must be configured with the correct API keys. Set the values in the playground's
Resources/ShopGunSDK-Config.plistfile with your own API keys (accessible from the ShopGun Developer page)
Also Note: Xcode Playgrounds can be a bit flaky when it comes to importing external frameworks. If it complains, try cleaning the build folder and rebuilding the SDK (targetting a simulator), and if it continues, restart Xcode. Also sometimes commenting out contents of the
playgroundLogHandler.swiftfile, and then uncommenting again, helps.
For a more detailed guide, see the Getting Started guide.
For a history of changes to the SDK, see the CHANGES file.
ShopGunSDK is released under the MIT license. See LICENSE for details.