clef/clef-php

Clef PHP Library

Clef PHP bindings

, _(*1)

A PHP wrapper for the Clef API. Authenticate a user and access their information in two lines of code., _(*2)

You can sign up for a Clef account at https://getclef.com., _(*3)

Requirements

PHP 5.3.3 and later., _(*4)

Composer

You can install the bindings via Composer. Add this to your composer.json:, _(*5)

{
  "require": {
    "clef/clef-php": "1.*"
  }
}

Then install via:, _(*6)

composer install

To use the bindings, use Composer's autoload:, _(*7)

require_once('vendor/autoload.php');

Manual Installation

If you do not wish to use Composer, you can download the latest release. Then, to use the bindings, include the init.php file., _(*8)

require_once('/path/to/clef-php/init.php');

Usage

Logging in a user

When a user logs in with Clef, the browser will redirect to your data-redirect-url. To retrieve user information, call get_login_information in that endpoint:, _(*9)

\Clef\Clef::initialize(APP_ID, APP_SECRET);
$response = \Clef\Clef::get_login_information($_GET["code"]);

For what to do after getting user information, check out our documentation on Associating users., _(*10)

Logging out a user

When you configure your Clef integration, you can also set up a logout hook URL. Clef sends a POST to this URL whenever a user logs out with Clef, so you can log them out on your website too., _(*11)

\Clef\Clef::initialize(APP_ID, APP_SECRET);
$clef_id = \Clef\Clef::get_logout_information($_POST["logout_token"]);

For what to do after getting a user who's logging out's clef_id, see our documentation on Database logout., _(*12)

Sample App

If you'd like to see an example of this library in action, check out the Clef PHP sample application here., _(*13)

Resources

Check out the API docs.
Access your developer dashboard., _(*14)