No description, website, or topics provided.
Objective-C Other
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
GfycatApiKit.xcodeproj
GfycatApiKit
GfycatApiKitTests
Tools
docs
.gitignore
Cartfile
Cartfile.resolved
GfycatApiKit.podspec
LICENSE
README.md

README.md

GfycatApiKit

Installation

Using CocoaPods

GfycatApiKit can be installed using CocoaPods package manager. To do so, please add corresponding reference in your Podfile:

pod 'GfycatApiKit'

Then run pod install to update CocoaPods installation in the project:

$ pod install

Please refer to CocoaPods documentation for more details.

Update Info.plist

The Gfycat API is accessible only when you provide GfycatApiClientId and GfycatApiClientSecret. Get them for free on the API Keys Management page. You need to have or create a Gfycat account and log in with those credentials to manage your keys.

Once you get those, update your Info.plist file accordingly.

<key>GfycatApiClientId</key>
<string>Your API Client ID goes here</string>
<key>GfycatApiClientSecret</key>
<string>Your API Client Secret goes here</string>

Analytics

The Gfycat server API endpoint requires view impressions and share event analytics to be reported.

You can report view impressions like this:

[GfycatEventTracker.impressionsTracker trackEvent:@"video_played" withParameters:@{
    @"gfyid": @"candidimmaterialdromedary",
    @"context": @"search",
    @"keyword": @"example_keyword",
    @"flow": @"full",
    @"viewtag": @"example_tag",
}];

And share events like this:

[GfycatEventTracker.analyticsTracker trackEvent:@"send_video" withParameters:@{
    @"gfyid": @"candidimmaterialdromedary",
}];

Please refer to the Gfycat Analytics documentation for more details on events and parameters.

Contact Us

Any questions or comments please send them to api@gfycat.com