pecee/happn-php-sdk

Easy to use PHP SDK for accessing Happn data.

1.3.0 2018-03-08 05:58 UTC

Requires

• pecee/http-service: 1.*

Requires (Dev)

• pecee/http-service: 1.*
• phpunit/phpunit: 4.7.7

MIT

• Simon Sessingø

• http
• rest
• api
• web
• sdk
• service
• pecee
• happn

README

Easy to use PHP SDK for accessing Happn data.

Installation

Add the latest version of happn-php-sdk to your composer.json

{
    "require": {
        "pecee/happn-php-sdk": "1.*"
    },
    "require-dev": {
        "pecee/happn-php-sdk": "1.*"
    }
}

Like this?

Like this SDK? Then you'll definetly love our "tinder-php-sdk", check it out here: https://github.com/skipperbent/tinder-php-sdk

Examples

This section contains basic examples on how to use the SDK.

Getting Facebook access token

To use the SDK - the api requires you to get a valid Facebook access token. This can be accomplished by following this link and copying the access_token parameter provided by Facebook after a successful login.

Authentication

Connect to the service, using your Facebook token.

$happn = new \Pecee\Http\Service\Happn($fbToken);

Get user information

Fetches user information

Returns dictionary packed with: user id, facebook id, twitter id (not implemented), first name, last name, birth date, login (nulled), workplace, distance

$response = $happn->getUserInfo($userId);

Get recommendations

Get recommendations from Happn server to the user authenticated.

$response = $happn->getRecommendations($limit = 16, $offset = 0);

Get distance

Fetches the distance from another user

$response = $happn->getDistance($userId);

Get Happn settings

Note: Will be updated soon with correct parameters

Set Happn settings.

$response = $happn->setSettings(array $userId);

Set position

Set the position of the user using Happn's API

$response = $happn->setPosition($lat, $lon);

Set position

Updates user activity

$response = $happn->updateActivity();

Get user id

Returns user id of the currently authenticated user

$response = $happn->getUserId();

Get Facebook access token

Returns Facebook access token of the currently authenticated user

$response = $happn->getFbToken();

Custom query

Make custom query upon Happn api.

$response = $happn->api($url, $method, array $data);

The MIT License (MIT)

Copyright (c) 2015 Simon Sessingø / happn-php-sdk

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.