Concepts
Scopes
Les scopes déterminent ce qu'une clé peut faire. Choisissez-les lors de la création de la clé et n'accordez à chaque clé que ce dont elle a besoin.
Une requête vers un endpoint dont le scope manque à la clé échoue avec 403 INSUFFICIENT_SCOPE. Il est impossible d'ajouter des scopes à une clé existante : créez une nouvelle clé et révoquez l'ancienne.
Non disponibles : paiements, wallet, tokens, transferts et paramètres du compte. Aucun scope n'y donne accès.
Tous les scopes#
| Scope | Autorise |
|---|---|
profile:read | Lire votre profil et les profils publics des autres utilisateurs. |
posts:read | Lire les posts (les vôtres et ceux que vous pouvez voir dans l'application) et leurs commentaires. |
posts:write | Importer des médias, publier, modifier et supprimer vos posts. |
comments:write | Écrire des commentaires et supprimer vos commentaires (ou les commentaires sur vos posts). |
likes:write | Aimer des posts et retirer un j'aime. |
follows:write | Suivre des utilisateurs et cesser de les suivre. |
stories:write | Publier des stories. |
store:read | Lire votre boutique Bloop et ses produits. |
store:write | Modifier votre boutique, créer, mettre à jour et supprimer des produits, mettre à jour les stocks. |
orders:read | Lire les commandes reçues par votre boutique. |
orders:write | Marquer des commandes comme expédiées. |
chat:read | Lire vos conversations et leurs messages. |
chat:write | Envoyer des messages (dans le respect de la règle anti-spam). |
Endpoints par scope#
Tous les chemins sont relatifs à https://api.linework.app/open/v1.
| Endpoint | Scope |
|---|---|
GET /me | profile:read |
GET /users/{id} | profile:read |
GET /users/by-username/{username} | profile:read |
GET /me/posts | posts:read |
GET /users/{id}/posts | posts:read |
GET /posts/{id} | posts:read |
GET /posts/{id}/comments | posts:read |
POST /media | posts:write, stories:write ou store:write |
POST /posts | posts:write |
PATCH /posts/{id} | posts:write |
DELETE /posts/{id} | posts:write |
POST /posts/{id}/comments | comments:write |
DELETE /comments/{id} | comments:write |
POST DELETE /posts/{id}/like | likes:write |
POST DELETE /users/{id}/follow | follows:write |
POST /stories | stories:write |
GET /store | store:read |
POST PATCH /store | store:write |
GET /store/products | store:read |
POST /store/products | store:write |
PATCH DELETE /store/products/{id} | store:write |
PATCH /store/products/{id}/stock | store:write |
GET /store/orders | orders:read |
GET /store/orders/{id} | orders:read |
POST /store/orders/{id}/ship | orders:write |
GET /conversations | chat:read |
GET /conversations/{id}/messages | chat:read |
POST /conversations/{id}/messages | chat:write |
POST /messages | chat:write |
La Référence de l'API fait foi : chaque opération indique le scope requis.
Combinaisons suggérées#
| Intégration | Scopes |
|---|---|
| Bot de publication | profile:read posts:read posts:write stories:write |
| Community manager | posts:read comments:write likes:write |
| Synchronisation de boutique | store:read store:write orders:read orders:write |
| Bot de support dans le chat | chat:read chat:write (+ orders:read pour consulter les commandes) |