- Documentation
- SDK PHP · Version 0.1
- Installation et authentification
Installation et authentification
Sur cette page
Le SDK s'installe par Composer, sans aucune dépendance, et s'authentifie avec une clé API créée dans le panel de Quiet Social : un identifiant qsc_… et un secret qss_….
Prérequis
- PHP 8.2 ou plus récent, avec les extensions
curletjson. - Aucun autre paquet : le SDK n'a aucune dépendance Composer.
- Un espace de travail Quiet Social et une clé API.
Installer
composer require quiet-social/php-social
Créer une clé
Les clés se créent dans le panel, page Clés API, par le propriétaire ou un administrateur de l'espace de travail : Créer une clé API, puis un nom, la marque (ou « Tout l'espace de travail ») et les droits. Le parcours complet est dans le guide.
Le secret n'est affiché qu'une fois, à la création. Rangez-le dans une variable d'environnement ou un gestionnaire de secrets, jamais dans le code.
Construire le client
use QuietSocial\Sdk\Client;
$client = new Client(
clientId: 'qsc_a1b2c3d4e5f6g7h8i9j0k1l2',
clientSecret: (string) getenv('QUIET_SOCIAL_SECRET'),
);
$me = $client->me();
$me->clientName; // le nom donné à la clé
$me->brand?->id; // brd_…, ou null pour une clé qui couvre tout l'espace
$me->can('publications:create'); // true si la clé porte ce droit
me() n'exige aucun droit : appelez-le en premier, pour savoir ce que la clé permet.
| Argument | Défaut | Note |
|---|---|---|
clientId |
L'identifiant qsc_…. |
|
clientSecret |
Le secret qss_…. |
|
baseUrl |
https://quietsocial.dev/api/v1 |
En https. Le http simple n'est accepté que pour localhost, 127.0.0.1, [::1], *.localhost et *.test. Toute autre adresse lève InvalidArgumentException. |
transport |
CurlTransport |
Voir Tests et transports. |
brand |
null |
La marque brd_… de tout appel qui n'en nomme pas. |
Clé de marque ou clé d'espace
Une clé rattachée à une marque publie pour cette marque, sans rien préciser.
Une clé qui couvre tout l'espace de travail doit dire pour quelle marque elle publie, sans quoi l'API refuse la publication (brand_required). Donnez la marque au client (new Client(..., brand: 'brd_…')) ou au post (Post::make()->brand('brd_…')). $client->defaultBrand() rend la marque du client, et $client->brands()->list() les marques que la clé voit, avec leur identifiant.
Les droits dont la clé a besoin
Chaque droit est une case à cocher sur la clé. Ne cochez que ceux que votre intégration utilise ; le détail de chaque droit est dans Périmètres.
| Appel | Droits |
|---|---|
publications()->create() |
publications:create, destinations:read (les cibles sont résolues d'abord), et media:create quand le post porte une image à envoyer |
publications()->find(), publications()->list() |
publications:read |
publications()->publish() |
publications:update |
publications()->cancel() |
publications:cancel |
publications()->retry() |
publications:retry |
destinations()->list(), destinations()->all(), destinations()->find() |
destinations:read |
media()->upload(), media()->delete() |
media:create (et media:read pour envoyer une Image::existing(), qui est relue) |
media()->find(), media()->list() |
media:read |
brands()->list() |
brands:read |
webhooks()->list(), webhooks()->create(), webhooks()->update(), webhooks()->delete(), webhooks()->test() |
webhooks:manage |
me() |
aucun |
Un appel sans le droit nécessaire lève PermissionDenied.
Le secret reste secret
Le secret n'apparaît jamais dans var_dump(), print_r(), var_export() ni dans une trace d'exception. Un client ne se sérialise pas (LogicException) : construisez-le là où il sert plutôt que de le ranger dans un cache ou de le passer à un job en file.