Skip to content
This repository has been archived by the owner. It is now read-only.
master
Switch branches/tags
Go to file
Code

Latest commit

 

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 

readme.md

BFRHelpScoutDocsClient

Summary

BFRHelpScoutDocsClient is a basic wrapper around the HelpScout Docs API. It requires AFNetworking as a dependency.

Use it to pull a list of articles from HelpScout Docs, before showing the selected article to a user.

We'll be putting together a demo project to help you hook up to your HelpScout Docs shortly.

We use it in Buffer for iOS :-).

Installation

Cocoapod Coming Soon.

Quickstart

To get up and running quickly with BFRHelpScoutDocsClient, configure it using your access token!

[[BFRHelpScoutDocsClient sharedClient] setAccessToken:@"YOURKEYHERE"];

Fetch Categories

[[BFRHelpScoutDocsClient sharedClient] getCategoriesWithCollectionID:@"COLLECTIONID" success:^(id responseObject) {
    // Handle Response
} failure:^(NSError *error) {
    // Handle Error
}];

Fetch Articles

[[BFRHelpScoutDocsClient sharedClient] getArticlesWithinCategory:@"CATEGORYID" success:^(id responseObject) {
    // Handle Response
} failure:^(NSError *error) {
    // Handle Error
}];

Fetch Article ID

[[BFRHelpScoutDocsClient sharedClient] getArticleWithID:@"ARTICLEID" success:^(id responseObject) {
    // Handle Response
} failure:^(NSError *error) {
    // Handle Error
}];

Increase View Count

[[BFRHelpScoutDocsClient sharedClient] increaseViewCountForArticleWithID:@"ARTICLEID" success:^(id responseObject) {
    // Handle Response
} failure:^(NSError *error) {
    // Handle Error
}];

Going Forward

We regularly maintain this code, and you can also rest assured that it's been battle tested against thousands of users in production 👍. That said, we get things wrong from time to time - so feel free to open an issue for anything you spot!

We are always happy to talk shop, so feel free to give us a shout on Twitter:

Or, hey - why not work on the BFRHelpScoutDocsClient and get paid for it!? We're hiring!


Licence

This project uses MIT License.

About

Allows you to grab content from HelpScout docs.

Resources

License

Releases

No releases published

Packages

No packages published