PHPackages                             smartsupp/php-partner-client - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. smartsupp/php-partner-client

ActiveLibrary

smartsupp/php-partner-client
============================

API client allows to register and login (obtain API key) from Smartsupp partner API.

1.1(6y ago)042.5k↓40.3%11PHPPHP &gt;=5.3.2CI failing

Since Jun 28Pushed 10mo ago12 watchersCompare

[ Source](https://github.com/smartsupp/php-auth-client)[ Packagist](https://packagist.org/packages/smartsupp/php-partner-client)[ Docs](https://www.smartsupp.com/)[ RSS](/packages/smartsupp-php-partner-client/feed)WikiDiscussions master Synced 1mo ago

READMEChangelog (2)Dependencies (1)Versions (4)Used By (1)

[![Build Status](https://camo.githubusercontent.com/fa3e1af54d44c9f8fb3b0a3d27e88ea9a2faca706c92990fe689484672732d23/68747470733a2f2f7472617669732d63692e6f72672f736d617274737570702f7068702d617574682d636c69656e742e737667)](https://travis-ci.org/smartsupp/php-auth-client)[![Coverage Status](https://camo.githubusercontent.com/e4987b5a22b8dd681f507b99e25f94cb8b4672333579e0a05355bc9c27631db5/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f736d617274737570702f7068702d617574682d636c69656e742f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/smartsupp/php-auth-client?branch=master)

Smartsupp Authentication API PHP client
=======================================

[](#smartsupp-authentication-api-php-client)

-

Get started
-----------

[](#get-started)

- Response is successfull if not contains `error` property in `$response` array.
- The `error` is machine-readable name of error, and `message` is human-readable description of error.

create
------

[](#create)

```
$api = new Smartsupp\Auth\Api();

$response = $api->create(array(
  'email' => 'LOGIN_EMAIL',           // required
  'password' => 'YOUR_PASSWORD',      // optional, min length 6 characters
  'name' => 'John Doe',               // optional
  'lang' => 'en',                     // optional, lowercase; 2 characters
  'partnerKey' => 'PARTNER_API_KEY'   // optional
));

// print_r($response);  // success response
array(
  'account' => array(
    'key' => 'CHAT_KEY',
    'lang' => 'en'
  ),
  'user' => array(
    'email' => 'LOGIN_EMAIL',
    'name' => 'John Doe',
    'password' => 'YOUR_PASSWORD'
  )
);

// print_r($response); // failure response
array(
    'error' => 'EmailExists',
    'message' => 'Email already exists',
    'hint' => 'email'
);
```

### Errors

[](#errors)

- `AuthError` - invalid PARTNER\_KEY.
- `InvalidParam` - missing or invalid parameter (e.g.: email).
- `EmailExists` - email is already taken.

login
-----

[](#login)

```
$api = new Smartsupp\Auth\Api();

$response = $api->login(array(
  'email' => 'LOGIN_EMAIL',
  'password' => 'YOUR_PASSWORD'
));

// print_r($response);  // success response
array(
  'account' => array(
    'key' => 'CHAT_KEY',
    'lang' => 'en'
  )
);

// print_r($response); // failure response
array(
  'error' => 'InvalidCredential',
  'message' => 'Invalid password'
);
```

### Errors

[](#errors-1)

- `AuthError` - invalid PARTNER\_KEY.
- `InvalidParam` - missing or invalid parameter (e.g.: email is not valid, password is too short).
- `IdentityNotFound` - account with this email not exists.
- `InvalidCredential` - email exists, bad password is incorrect.
- `LoginFailure` - something is bad with login.

Requirements
------------

[](#requirements)

For backward compatibility with multiple plugins library supports PHP starting from version 5.3. It is highly possibly the constraint will change to 5.6+ in near future.

Copyright
---------

[](#copyright)

Copyright (c) 2016 Smartsupp.com, s.r.o.

###  Health Score

39

—

LowBetter than 86% of packages

Maintenance39

Infrequent updates — may be unmaintained

Popularity29

Limited adoption so far

Community20

Small or concentrated contributor base

Maturity60

Established project with proven stability

 Bus Factor1

Top contributor holds 81.8% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~809 days

Total

3

Last Release

1992d ago

Major Versions

1.1 → 2.x-dev2020-12-03

PHP version history (2 changes)1.0PHP &gt;=5.3.2

2.x-devPHP &gt;=7.3

### Community

Maintainers

![](https://www.gravatar.com/avatar/a514b1929cc7200362951dda332e79e046b7e749feab81e1d1b1baa475c83935?d=identicon)[smartsupp](/maintainers/smartsupp)

![](https://www.gravatar.com/avatar/18b93d6bbf3f004affb009905d3ff7f6f92a267e2311d83596db443f8d3a301b?d=identicon)[marekgach](/maintainers/marekgach)

---

Top Contributors

[![marekgach](https://avatars.githubusercontent.com/u/7091135?v=4)](https://github.com/marekgach "marekgach (27 commits)")[![dkMorlok](https://avatars.githubusercontent.com/u/2921037?v=4)](https://github.com/dkMorlok "dkMorlok (3 commits)")[![slepic](https://avatars.githubusercontent.com/u/8199404?v=4)](https://github.com/slepic "slepic (2 commits)")[![famousgarkin](https://avatars.githubusercontent.com/u/144425?v=4)](https://github.com/famousgarkin "famousgarkin (1 commits)")

---

Tags

chat

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/smartsupp-php-partner-client/health.svg)

```
[![Health](https://phpackages.com/badges/smartsupp-php-partner-client/health.svg)](https://phpackages.com/packages/smartsupp-php-partner-client)
```

###  Alternatives

[munafio/chatify

A package for Laravel PHP Framework to add a complete real-time chat system.

2.4k441.9k2](/packages/munafio-chatify)[musonza/chat

Chat Package for Laravel

1.2k253.4k1](/packages/musonza-chat)[gnello/php-mattermost-driver

The Php Driver to interact with the Mattermost Web Service API

84304.8k5](/packages/gnello-php-mattermost-driver)[rajentrivedi/tokenizer-x

TokenizerX calculates required tokens for given prompt

91214.0k3](/packages/rajentrivedi-tokenizer-x)[get-stream/stream-chat

A PHP client for Stream Chat (https://getstream.io/chat/)

301.8M2](/packages/get-stream-stream-chat)[gidkom/php-openfire-restapi

Manage Open fire server using Rest Api

56158.6k](/packages/gidkom-php-openfire-restapi)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)
