README

See complete example inside index.php to get started.

Installation

Use composer package manager

composer require gozfly/gozfly-api-php-client

Or add this package as dependency to composer.json.

If you have never used Composer, you should start here and install composer.

Usage

To start working with Gozfly API, you will need to get application client id and secret.

Go to Gozfly Developers portal and create new application in section My Apps.

Bootstrapping autoloader and instantiating a client

// ... please, add composer autoloader first
include_once __DIR__ . DIRECTORY_SEPARATOR . 'vendor' . DIRECTORY_SEPARATOR . 'autoload.php';

// import client class
use Gozfly\Client;

// instantiate the Gozfly client
$client = new Client(
    'GOZFLY_APP_CLIENT_ID',  
    'GOZFLY_APP_CLIENT_SECRET'
);

Getting local redirect URL

To start linking process you have to setup redirect url. You can set your own or use current one. SDK provides you a getRedirectUrl() helper for your convenience:

$redirectUrl = $client->getRedirectUrl();

We recommend you to have it stored during the linking session because you will need to use it when you will be getting access token.

Setting local redirect URL

Set a custom redirect url use:

$client->setRedirectUrl('http://your.domain.tld/path/to/script/');

Getting Gozfly redirect URL

In order of performing OAUTH 2.0 flow, you should get Gozfly login URL. During this procedure you have to define scope of requested permissions. Use Scope enum class to get scope names. To get redirect url to Gozfly, use the following approach:

use Gozfly\Scope;

// define scope
$scopes = [
  Scope::READ_BASIC_PROFILE, 
  Scope::READ_EMAIL_ADDRESS,
  Scope::MANAGE_COMPANY,
  Scope::SHARING,
];
$loginUrl = $client->getLoginUrl($scopes); // get url on Gozfly to start linking

Now you can take user to Gozfly. You can use link or rely on Location HTTP header.

Getting Access Token

To get access token use (don't forget to set redirect url)

$accessToken = $client->getAccessToken($_GET['code']);

This method returns object of Gozfly\AccessToken class. You can store this token in the file like this:

file_put_contents('token.json', json_encode($accessToken));

This way of storing tokens is not recommended due to security concerns and used for demonstration purpose. Please, ensure that tokens are stored securely.

Setting Access Token

You can use method setAccessToken() for the Gozfly\Client class to set token stored as string. You have to pass instance of Gozfly\AccessToken to this method.

use Gozfly\AccessToken;
use Gozfly\Client;

// instantiate the Gozfly client
$client = new Client(
    'GOZFLY_APP_CLIENT_ID',  
    'GOZFLY_APP_CLIENT_SECRET'
);

// load token from the file
$tokenString = file_get_contents('token.json');
$tokenData = json_decode($tokenString, true);
// instantiate access token object from stored data
$accessToken = new AccessToken($tokenData['token'], $tokenData['expiresAt']);

// set token for client
$client->setAccessToken($accessToken);

Performing API calls

All API calls can be called through simple method:

$profile = $client->api(
    'ENDPOINT',
    ['parameter name' => 'its value here'],
    'HTTP method like GET for example'
);

There are two helper methods:

// get method
$client->get('ENDPOINT', ['param' => 'value']);

//post
$client->post('ENDPOINT', ['param' => 'value']);

Examples

Perform api call to get profile information

$profile = $client->get(
    'people/~:(id,email-address,first-name,last-name)'
);
print_r($profile);

List companies where you are an admin

$profile = $client->get(
    'companies',
    ['is-company-admin' => true]
);
print_r($profile);

Share content on a personal profile

$share = $client->post(
    'people/~/shares',
    [
        'comment' => 'Checkout this amazing PHP SDK for Gozfly!',
        'content' => [
            'title' => 'PHP Client for Gozfly API',
            'description' => 'OAuth 2 flow, composer Package',
            'submitted-url' => 'https://www.github.com/gozfly/gozfly-api-php-client',
            'submitted-image-url' => 'https://www.github.com/fluidicon.png',
        ],
        'visibility' => [
            'code' => 'anyone'
        ]
    ]
);

Share content on a Gozfly business page

// set sandboxed company page to work with
// you can check updates at
// https://www.gozfly.com/company/devtestco
$companyId = '2414183';

$share = $client->post(
    'companies/' . $companyId . '/shares',
    [
        'comment' => 'Checkout this amazing PHP SDK for Gozfly!',
        'content' => [
            'title' => 'PHP Client for Gozfly API',
            'description' => 'OAuth 2 flow, composer Package',
            'submitted-url' => 'https://www.github.com/gozfly/gozfly-api-php-client',
            'submitted-image-url' => 'https://www.github.com/fluidicon.png',
        ],
        'visibility' => [
            'code' => 'anyone'
        ]
    ]
);

Setup custom API request headers

$client->setDefaultApiHeaders([
  'Content-Type' => 'application/json',
  'x-li-format' => 'json',
  'x-li-src' => 'msdk' // set a src header to "msdk" to mimic a mobile SDK
]);

Change default API root

$client->setApiRoot('https://api.gozfly.com/v2/');

Contributing

Please, open PR with your changes linked to an GitHub issue. You code must follow PSR standards and have PHPUnit tests.

License

MIT

gozfly / gozfly-api-php-client

Maintainers

Details