highoctanehosting / untapped-api Goto Github PK

PHP library to interact with the public Untappd API version 4, patterned
after other service libraries in Zend Framework.

Information on the API can be found on Untappd's website.
http://untappd.com/api/dashboard

A client ID and client secret is required.  An access token is required for
certain method calls, such as myFriendFeed.  Contact Untappd to attain your
credentials.

This library also contains 2 helper methods to generate the correct authenticate
URI for OAuth2 authentication, as well as a method to exchange a "code" from your
redirect URI for an access token.  Examples are below.

==============================================

Installation:

Using composer:

Add the repository to your composer.json file

    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/PintLabs/Pintlabs_Service_Untappd.git"
        }
    ],

Add the library to your requirements list:

    "require": {
        "php": ">=5.5.9",
        "laravel/framework": "5.2.*",
        "fabpot/goutte": "^3.1",
        "PintLabs/Pintlabs_Service_Untappd": "*@dev"
    },

Add the Untappd dir to your autoload list:

    "autoload": {
        "classmap": [
            "vendor/Pintlabs/Pintlabs_Service_Untappd/library/Pintlabs/Service/"
        ],
    }


Run `composer update`

==============================================

Usage:

<?php

// Setup Untappd
$config = array(
    'clientId'     => $clientId,
    'clientSecret' => $clientSecret,
    'accessToken'  => $accessToken,
    'redirectUri'  => $redirectUri,
);

$untappd = new Pintlabs_Service_Untappd($config);


// Example 1:  Basic method call
try {
    $result = $untappd->myFriendFeed();
} catch (Pintlabs_Service_Untappd_Exception $e) {
    die($e->getMessage());
}


// Example 2:  Redirecting to Untappd OAuth2 authentication URI
header('Location: ' . $untappd->authenticateUri());


// Example 3:  Exchanging code argument for access token
$accessToken = $untappd->getAccessToken($_GET['code']);