- Documentation
- API · Version 1.0
- Authentification
Authentification
Sur cette page
L'API authentifie une application, pas une personne. Chaque application cliente reçoit un identifiant public et un secret, qu'elle présente en authentification HTTP Basic à chaque requête.
Obtenir des identifiants
Un client d'API appartient à un espace de travail et, s'il y a lieu, à une seule marque de cet espace. Il porte une liste de périmètres qui décide de ce qu'il peut faire.
Les clés se créent dans le tableau de bord, menu Clés API, ouvert aux administrateurs et au propriétaire de l'espace : 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.
- L'identifiant commence par
qsc_, le secret parqss_. - Le secret n'est affiché qu'une fois, à la création. Seule son empreinte est conservée : il ne peut pas être relu, et le perdre impose de créer une nouvelle clé.
- Rangez-le dans un gestionnaire de secrets ou une variable d'environnement, jamais dans le code source.
- Une clé révoquée depuis le tableau de bord perd l'accès dès sa requête suivante, et ne se réactive pas.
Présenter les identifiants
L'identifiant est le nom d'utilisateur, le secret est le mot de passe :
curl https://quietsocial.dev/api/v1/me \
-u "qsc_a1b2c3d4e5f6g7h8i9j0k1l2:qss_…"
Ce qui revient à envoyer l'en-tête :
Authorization: Basic base64(identifiant:secret)
Les mêmes identifiants sont aussi acceptés en jeton porteur, en clair, séparés par deux-points — la forme que savent poser la plupart des clients du serveur MCP :
Authorization: Bearer qsc_a1b2c3d4e5f6g7h8i9j0k1l2:qss_…
La vérification et les refus sont les mêmes qu'en Basic.
Tout client HTTP sait produire l'en-tête Basic. En Laravel :
use Illuminate\Support\Facades\Http;
$response = Http::baseUrl('https://quietsocial.dev/api/v1')
->withBasicAuth(config('services.quiet_social.client_id'), config('services.quiet_social.client_secret'))
->acceptJson()
->get('/me');
Aucune route de l'API n'est publique. Une requête sans identifiants valides reçoit 401 :
{
"error": {
"code": "unauthenticated",
"message": "Invalid credentials."
}
}
Un identifiant inconnu, un secret faux et un client révoqué reçoivent le même code, le même message et prennent le même temps : la réponse ne permet pas de deviner quels identifiants existent. Quand l'en-tête manque, ou n'est ni du Basic décodable ni un jeton porteur identifiant:secret, le message devient « Send your client ID and secret with HTTP Basic authentication, or as a Bearer token "client_id:secret". » ; le code reste unauthenticated.
GET /me
Dit qui est le client appelant. C'est la seule route qui n'exige aucun périmètre.
curl https://quietsocial.dev/api/v1/me \
-u "$QUIET_CLIENT_ID:$QUIET_CLIENT_SECRET"
{
"data": {
"client": {
"id": "qsc_a1b2c3d4e5f6g7h8i9j0k1l2",
"name": "Site vitrine",
"abilities": [
"destinations:read",
"publications:read",
"publications:create",
"media:create"
]
},
"workspace": {
"name": "Fabrique du Nord"
},
"brand": {
"id": "brd_01k4b8x2q9r7f3m5t6v8w0y2z4",
"name": "Fabrique du Nord",
"timezone": "Europe/Paris"
}
}
}
client.abilitiesliste les périmètres accordés. Comparez-la à ce dont votre intégration a besoin dès le démarrage.brandvautnullquand le client couvre tout l'espace de travail. C'est le test à faire pour savoir si vos écritures doivent porterbrand_id(voir Périmètres).- L'espace de travail ne rend que son nom : il n'a pas d'identifiant public, rien dans l'API ne se désigne par un espace.
Codes : 200, 401, 429.
Ce que l'API enregistre
Chaque appel authentifié met à jour la date et l'adresse IP de dernier usage du client, et compte une requête dans la consommation de l'espace de travail. Ces écritures ont lieu après la réponse : elles ne la retardent pas, et leur échec ne fait pas échouer l'appel.