- Documentation
- SDK PHP · Version 0.1
- Introduction
Introduction
Sur cette page
Le SDK PHP quiet-social/php-social publie sur Facebook, Instagram, LinkedIn, Threads et Pinterest depuis n'importe quelle application PHP. Il parle à l'API de Quiet Social à votre place : un post décrit une fois, ses images envoyées, ses cibles résolues dans la marque, et chaque refus traduit en exception nommée.
Premier exemple
use QuietSocial\Sdk\Client;
use QuietSocial\Sdk\Post;
$client = new Client(
clientId: 'qsc_a1b2c3d4e5f6g7h8i9j0k1l2',
clientSecret: (string) getenv('QUIET_SOCIAL_SECRET'),
);
$publication = $client->publications()->create(
Post::make('Notre carte d\'automne est en ligne.')->link('https://exemple.fr/carte')->reference('carte:automne'),
to: ['facebook', 'linkedin'],
);
echo $publication->id; // pub_…
La clé doit porter au moins les droits publications:create et destinations:read. Une clé qui couvre tout l'espace de travail doit aussi nommer la marque : new Client(..., brand: 'brd_…') (voir Installation et authentification).
Cet appel lit les destinations Facebook et LinkedIn de la marque, crée la publication avec une clé d'idempotence tirée de la référence carte:automne, et rend la publication telle que l'API l'a enregistrée.
Ce que fait le SDK, et ce qu'il laisse à l'API
Le SDK vérifie la forme : un lien absolu, des tags en chaînes de caractères, un titre réservé à Pinterest, pas de lien sur Instagram. Une faute de forme lève InvalidPost avant tout envoi.
L'API vérifie le fond : la longueur du texte sur chaque réseau, le nombre de hashtags, l'image qu'exigent Instagram et Pinterest, le quota de la marque. Un refus de l'API lève ValidationFailed, avec la raison de chaque destination.
Tout ce que fait le SDK passe par l'API REST v1 : il n'ouvre aucune porte qu'elle n'ouvre pas, et ses droits sont ceux de la clé qui l'authentifie.
Les pages de cette documentation
- Installation et authentification : prérequis, clé API, construction du client, droits à cocher.
- Publier : décrire un post, programmer, les modes, les surcharges par réseau, l'idempotence, suivre une publication.
- Images : les quatre sources d'une image, le texte alternatif, la sécurité des images distantes.
- Ciblage : noms de réseau, identifiants
dst_…, destination par son nom. - Erreurs : la table des exceptions, et quand réessayer.
- Webhooks : déclarer un endpoint, vérifier une notification.
- Tests et transports :
FakeTransport,CurlTransportet transports personnalisés.
Limites connues
- Une image par post, et une par réseau. Ni galerie, ni vidéo.
- X se déclare, il ne se publie pas.
Network::Xexiste pour qu'un post partagé puisse déjà le régler, mais l'API ne publie encore rien sur X :to: ['x']lèveValidationFailedde codedestination_unavailable. - Pas encore de premier commentaire.
firstComment()est accepté, mais aucun réseau n'en publie : l'API ignore le commentaire commun et refuse celui qui est posé pour un seul réseau. - Les règles des réseaux sont vérifiées par l'API, pas par le SDK : elles remontent par
ValidationFailed, destination par destination. - Une clé d'idempotence vit 24 heures. Elle protège d'un appel relancé, pas d'un post renvoyé des jours plus tard.
Versions
Le SDK suit le versionnage sémantique. Avant la 1.0, une version mineure peut changer l'API publique ; le journal des modifications du paquet (CHANGELOG.md) dit ce qui a changé. Cette documentation décrit la version 0.1, qui fonctionne avec la version 1 de l'API (/api/v1).
Le code source est publié sur GitHub, en miroir en lecture seule : les pull requests y sont fermées, les issues y sont bienvenues.