- Documentación
- SDK PHP · Versión 0.1
- Instalación y autenticación
Instalación y autenticación
En esta página
El SDK se instala con Composer, sin ninguna dependencia, y se autentica con una clave API creada en el panel de Quiet Social: un identificador qsc_… y un secreto qss_….
Requisitos
- PHP 8.2 o posterior, con las extensiones
curlyjson. - Ningún otro paquete: el SDK no tiene ninguna dependencia de Composer.
- Un espacio de trabajo de Quiet Social y una clave API.
Instalar
composer require quiet-social/php-social
Crear una clave
Las claves se crean en el panel, página Clés API (Claves API), por el propietario o un administrador del espacio de trabajo: Créer une clé API (Crear una clave API), luego un nombre, la marca (o «Tout l'espace de travail», todo el espacio de trabajo) y los permisos. El recorrido completo está en la guía.
El secreto se muestra una sola vez, al crear la clave. Guárdalo en una variable de entorno o en un gestor de secretos, nunca en el código.
Construir el cliente
use QuietSocial\Sdk\Client;
$client = new Client(
clientId: 'qsc_a1b2c3d4e5f6g7h8i9j0k1l2',
clientSecret: (string) getenv('QUIET_SOCIAL_SECRET'),
);
$me = $client->me();
$me->clientName; // el nombre dado a la clave
$me->brand?->id; // brd_…, o null para una clave que cubre todo el espacio
$me->can('publications:create'); // true si la clave tiene este permiso
me() no exige ningún permiso: llámalo primero, para saber lo que permite la clave.
| Argumento | Por defecto | Nota |
|---|---|---|
clientId |
El identificador qsc_…. |
|
clientSecret |
El secreto qss_…. |
|
baseUrl |
https://quietsocial.dev/api/v1 |
En https. El http simple solo se acepta para localhost, 127.0.0.1, [::1], *.localhost y *.test. Cualquier otra dirección lanza InvalidArgumentException. |
transport |
CurlTransport |
Ver Pruebas y transportes. |
brand |
null |
La marca brd_… de toda llamada que no nombre ninguna. |
Clave de marca o clave de espacio
Una clave vinculada a una marca publica para esa marca, sin precisar nada más.
Una clave que cubre todo el espacio de trabajo debe decir para qué marca publica; si no, la API rechaza la publicación (brand_required). Da la marca al cliente (new Client(..., brand: 'brd_…')) o al post (Post::make()->brand('brd_…')). $client->defaultBrand() devuelve la marca del cliente, y $client->brands()->list() las marcas que ve la clave, con su identificador.
Los permisos que necesita la clave
Cada permiso es una casilla en la clave. Marca solo los que usa tu integración; el detalle de cada permiso está en Permisos.
| Llamada | Permisos |
|---|---|
publications()->create() |
publications:create, destinations:read (los destinos se resuelven primero), y media:create cuando el post lleva una imagen que enviar |
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 (y media:read para enviar una Image::existing(), que se vuelve a leer) |
media()->find(), media()->list() |
media:read |
brands()->list() |
brands:read |
webhooks()->list(), webhooks()->create(), webhooks()->update(), webhooks()->delete(), webhooks()->test() |
webhooks:manage |
me() |
ninguno |
Una llamada sin el permiso necesario lanza PermissionDenied.
El secreto sigue siendo secreto
El secreto nunca aparece en var_dump(), print_r(), var_export() ni en una traza de excepción. Un cliente no se puede serializar (LogicException): constrúyelo donde se usa en lugar de guardarlo en una caché o pasarlo a un job en cola.