Authentification et limites de débit
Authentification
Chaque requête vers /api/v1/* s'authentifie avec une clé API, transmise comme jeton Bearer dans l'en-tête Authorization :
Authorization: Bearer sy_...Les clés API commencent par sy_ et ne sont montrées en entier qu'une seule fois, au moment de leur création. Ensuite, vous ne verrez plus que les quatre premiers et quatre derniers caractères. Les clés expirent après 30, 90 (par défaut) ou 365 jours ; utiliser une clé expirée renvoie un 401.
Créez une clé dans Paramètres → Développeur → Clés API. Chaque clé est associée à un modèle de permissions et à un réglage d'accès client :
Lecture seule — Lecture sur toutes les ressources — aucune écriture, aucune publication.
Accès complet — Lecture et écriture partout, y compris la publication et la gestion d'équipe. À réserver aux systèmes que vous contrôlez entièrement.
Personnalisé — Choisissez lecture, lecture et écriture, ou aucun accès pour chaque ressource. La liste complète s'affiche à la création de la clé.
Tous les clients — La clé peut accéder à tous les clients de votre agence, y compris ceux que vous ajoutez plus tard.
Clients spécifiques — La clé est limitée à une liste fixe de clients que vous choisissez à sa création. Les requêtes pour tout autre client renvoient un 403.
Limites de débit
Les limites de débit s'appliquent par agence, pas par clé, et varient selon votre forfait. Si vous ne connaissez pas la vôtre, contactez votre équipe de compte.
Si vous dépassez votre limite, vous recevrez une réponse 429 avec un en-tête Retry-After indiquant le nombre de secondes à attendre avant de réessayer.
Chaque réponse d'erreur inclut un champ error décrivant ce qui s'est passé. Certains types d'erreur incluent des champs supplémentaires avec plus de détails :
{
"error": "locationId is required"
}Codes de statut
200 | La requête a réussi. |
201 | Une ressource a été créée. |
400 | Il manque un paramètre requis à la requête, ou elle est invalide. |
401 | La clé API est manquante, invalide, expirée ou révoquée. |
403 | La clé n'a pas la permission requise pour cette requête, ou n'est pas autorisée pour le client/l'établissement concerné. |
404 | La ressource demandée n'existe pas, ou n'appartient pas à votre agence. |
409 | La requête entre en conflit avec l'état actuel de la ressource — par exemple en essayant de supprimer un élément déjà archivé. |
422 | La requête est bien formée mais ne passe pas la validation — par exemple un identifiant client invalide. |
429 | Vous avez atteint la limite de débit. Attendez le nombre de secondes indiqué dans Retry-After, puis réessayez. |