Présentation
Prise en main
De zéro à votre premier appel d'API en quelques minutes (plus le temps nécessaire pour approuver votre accès).
1. Demander l'accès développeur#
L'API est ouverte à tous les utilisateurs de Linework, mais l'accès est examiné manuellement afin que les bots restent utiles et que le spam reste dehors.
- Connectez-vous à l'application web et ouvrez web.linework.app → Paramètres → Développeurs.
- Remplissez la demande :
- Cas d'usage — ce que fait votre intégration, en quelques phrases (par exemple « publier le menu du jour de mon restaurant et répondre aux questions dans le chat »).
- Site web — votre site ou la page du projet, si vous en avez un.
- Nom du bot — le nom de votre application ou de votre bot, visible par nous et dans votre liste de clés.
- Envoyez-la. Vous verrez son statut (en attente, approuvée ou refusée) sur la même page.
L'API fonctionne sur votre propre compte. Si le bot doit avoir sa propre identité (par exemple « Pizza Roma Bot »), créez-lui un compte Linework distinct, avec une photo de profil et une couverture, et demandez l'accès depuis ce compte.
2. Créer une clé d'API#
Une fois l'accès approuvé, la page Développeurs vous permet de créer des clés d'API :
- Cliquez sur Créer une clé et donnez-lui un nom (par exemple « store-sync production »).
- Sélectionnez uniquement les scopes dont l'intégration a besoin.
- Copiez la clé. Elle se compose de
lwk_suivi de 40 caractères et n'est affichée qu'une seule fois.
Conservez-la dans une variable d'environnement ou un gestionnaire de secrets, jamais dans votre code source :
export LINEWORK_API_KEY="lwk_your_key_here"
Pour en savoir plus sur les clés, les limites et la révocation, consultez Authentification et clés d'API.
3. Effectuer votre premier appel#
GET /me renvoie le compte auquel appartient la clé. C'est le moyen le plus rapide de vérifier que tout fonctionne.
curl -i https://api.linework.app/open/v1/me \
-H "Authorization: Bearer $LINEWORK_API_KEY"
const res = await fetch("https://api.linework.app/open/v1/me", {
headers: { Authorization: `Bearer ${process.env.LINEWORK_API_KEY}` },
});
if (!res.ok) throw new Error(JSON.stringify(await res.json()));
console.log(await res.json());
import os, requests
r = requests.get(
"https://api.linework.app/open/v1/me",
headers={"Authorization": f"Bearer {os.environ['LINEWORK_API_KEY']}"},
timeout=30,
)
r.raise_for_status()
print(r.json())
Une réponse réussie est un objet JSON décrivant votre profil. Si vous obtenez 401 INVALID_API_KEY, vérifiez que l'en-tête est exactement Authorization: Bearer lwk_… et que la clé n'a pas été révoquée. Les champs exacts de la réponse sont listés dans la Référence de l'API.
4. Créer quelque chose#
Publier avec des médias
Importez une photo et publiez-la.
Répondre aux commentaires
Répondez à votre communauté.
Gérer une boutique Bloop
Produits, stocks, commandes, expédition.
Bot de support dans le chat
Répondez aux clients dans le chat.
Avant la mise en production#
- Utilisez une clé par intégration, afin de pouvoir en révoquer une sans arrêter les autres.
- Respectez les limites de débit et les quotas journaliers et gérez les
429avec une nouvelle tentative. - Gérez les erreurs selon leur
code, et non selon le texte du message. - Lisez les Conditions d'utilisation de l'API.