Skip to content

duylaurent-tran/feedly-api

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

32 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

feedly-api

PHP wrapper around Feedly's REST API.

Under Construction! Not every API's functionality implemented yet.

Notes

Check the example before anything.

If you are working in Sandbox mode of Feedly's API you should know a couple of things.

  • Your Client's ID, secret must taken from here, which is updated very often so be sure to check it once in while.
  • While in Sandbox mode, only "http://localhost" is permited for callback url. So leave it as is and just replace it every time with your domain, if it's different. You can also add you own to permitted domains here.
  • Once you've done developing you can contact Feedly and ask them to put you on production.

Instalation

Add this to your composer.json

"require": {
        "kbariotis/feedly-api": "dev-master"
    }

Or download the ZIP.

Documentation

Constructor:

    /**
     * @param boolean $sandbox                   Enable/Disable Sandbox Mode
     * @param boolean $storeAccessTokenToSession Choose whether to store the Access token
     *                                           to $_SESSION or not
     */

    $feedly = new Feedly($sandbox=FALSE, $storeAccessTokenToSession=TRUE);
    /**
     * Return authorization URL
     * @param string $client_id     Client's ID provided by Feedly's Administrators
     * @param string $redirect_uri  Endpoint to reroute with the results
     * @param string $response_type
     * @param string $scope
     *
     * @return string Authorization URL
     */
    $feedly->getLoginUrl($client_id, $redirect_uri,
        $response_type="code", $scope="https://cloud.feedly.com/subscriptions")
    /**
     * Exchange a `code` got from `getLoginUrl` for an `Access Token`
     * @param string $client_id     Client's ID provided by Feedly's Administrators
     * @param string $client_secret Client's Secret provided by Feedly's Administrators
     * @param string $auth_code     Code obtained from `getLoginUrl`
     * @param string $redirect_url  Endpoint to reroute with the results
     */
    $feedly->GetAccessToken($client_id, $client_secret, $auth_code,
        $redirect_url)

Get The Profile of The User

/**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getProfile($token=NULL)

Update The Profile of The User

/**
     * @param string $email
     * @param string $givenName
     * @param string $familyName
     * @param string $picture
     * @param boolean $gender
     * @param string $locale
     * @param string $reader google reader id
     * @param string $twitter twitter handle. example: edwk
     * @param string $facebook facebook id
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json Response from the server
     */
     $feedly->setProfile($token=NULL, $email=NULL, $givenName=NULL, $familyName=NULL,
        $picture=NULL, $gender=NULL, $locale=NULL,
        $reader=NULL, $twitter=NULL, $facebook=NULL)

Get The Preferences of The User

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getPreferences($token=NULL)

Get The List Of All Categories

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getCategories($token=NULL)

Change The Label Of an Existing Category

/**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @param  string $label Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->renameCategory($token=NULL, $label)

Get The Subscriptions of The User

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getSubscriptions($token=NULL)

Get The Metadata About a Specific Feed

    /**
     * @param  string $feedId Feed's ID
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getFeedMetadata($feedId, $token=NULL)

Get The Content of A Stream

    /**
     * @param  string $streamId Stream's ID
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getStreamContent($streamId, $count=NULL, $ranked=NULL,
        $unreadOnly=NULL, $newerThan=NULL, $continuation=NULL, $token=NULL)

Get a mix of the most engaging content available in a stream

    /**
     * @param  string $streamId Stream's ID
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getMixes($streamId, $count=NULL, $unreadOnly=NULL,
        $newerThan=NULL, $hours=NULL, $token=NULL)

Get a List of Entry IDs For a Specific Stream

    /**
     * @param  string $streamId Stream's ID
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getStreamIds($streamId, $count=NULL, $ranked=NULL,
        $unreadOnly=NULL, $newerThan=NULL, $continuation=NULL, $token=NULL)

Get The List Of Topics The User Has Added To Their Feedly

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getTopics($token=NULL)

Get The List Of Tags Created By The User.

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
   $feedly->getTags($token=NULL)

Find Feeds Based On Title, Url Or #topichttp://developer.feedly.com/

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->searchFeeds($q, $n=NULL, $token=NULL)

Get The List Of Onread Counts

    /**
     * @param  string $token Access Token in case we don't store it to $_SESSION
     * @return json   Response from the server
     */
    $feedly->getUnreadCounts($autorefresh=NULL, $newerThan=NULL,
        $streamId=NULL, $token=NULL)

Licence

The MIT License (MIT)

Copyright (c) 2014 Konstantinos Bariotis

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

About

PHP wrapper around Feedly's REST API

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • PHP 100.0%