PHPackages                             allus/company-data - 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. [API Development](/categories/api)
4. /
5. allus/company-data

ActiveLibrary[API Development](/categories/api)

allus/company-data
==================

PHP SDK for the allus company-data API: typed, plaintext, slug-keyed conclusions with transparent decryption.

v0.0.2(yesterday)00MITPHPPHP >=8.1CI passing

Since Jun 18Pushed yesterdayCompare

[ Source](https://github.com/allus-fyi/company-data-php)[ Packagist](https://packagist.org/packages/allus/company-data)[ Docs](https://github.com/allus-fyi/company-data-php)[ RSS](/packages/allus-company-data/feed)WikiDiscussions main Synced today

READMEChangelogDependencies (2)Versions (2)Used By (0)

allus/company-data (PHP)
========================

[](#alluscompany-data-php)

The PHP SDK for the **allus company-data API**. Point it at a JSON config file and it hands back typed, plaintext, **your-slug-keyed conclusions**: for each connected person, a map of *your request-field slug → plaintext value* (plus whether the value is live and when it last changed).

The SDK hides everything else — the OAuth token, the field catalog, the id plumbing, the hybrid decryption, binary fetching, the changes-queue mechanics, JSON-vs-XML. The platform is **zero-knowledge**: the API only ever holds ciphertext, so all decryption happens inside the SDK with your service private key. **The person's own field choices are never exposed** — you only ever see the request slots you configured.

> This SDK is one of six language ports that share an identical API surface. This manual is the PHP view of it.

**Contents:** [TL;DR — fetch new updates](#tldr--fetch-new-updates) · [Quickstart](#quickstart) · [Every call](#every-call) · [The typed value model](#the-typed-value-model) · [The changes pump](#the-changes-pump) · [Webhooks](#webhooks) · [Rate limits](#rate-limits) · [Errors](#errors) · [How it's wired](#how-its-wired)

Deeper reference pages live in [`docs/`](docs/): [config](docs/config.md) · [model](docs/model.md) · [pump](docs/pump.md) · [webhooks](docs/webhooks.md) · [errors](docs/errors.md).

---

TL;DR — fetch new updates
-------------------------

[](#tldr--fetch-new-updates)

```
composer require allus/company-data
```

Point a config.json at your service keys:

```
{
  "api_url": "https://api.allme.fyi",
  "client_id": "svc_xxx",
  "client_secret": "xxx",
  "service_private_key": "/path/to/service.pem",
  "key_passphrase": "xxx",
  "cache_dir": "./allus-cache"
}
```

Drain everything new, handled one update at a time:

```