Accès API
Créer un jeton pour brancher un agent IA ou un outil d'automatisation sur Squoad.
Accéder rapidement à une page de documentation
Créer un jeton pour brancher un agent IA ou un outil d'automatisation sur Squoad.
Créez un jeton pour qu'un agent IA ou un outil d'automatisation agisse dans Squoad à votre place.
Le jeton apparaît dans la liste à l'état Équipement.
| Portée | Ce que l'outil peut faire |
|---|---|
| Lecture seule | Consulter les clients, adresses, prestations du catalogue, modèles de formulaire, membres, équipes, équipements, missions et rapports de l'établissement |
| Lecture et écriture | Consulter, puis créer des clients, des adresses, des missions et des modèles de formulaire. Créer, modifier et retirer des prestations du catalogue |
En écriture, l'outil planifie aussi vos missions : dates, statut, opérateurs, équipes, équipements et prestations.
Il ajoute jusqu'à 30 prestations au catalogue en une fois. Une catégorie absente est créée. Une prestation dont le nom figure déjà au catalogue n'est pas recréée.
Il modifie ou retire aussi jusqu'à 30 prestations en une fois. Il leur rattache des modèles de formulaire ou les en détache. Une prestation retirée est supprimée si aucune mission ni demande ne l'utilise. Sinon, elle est désactivée et reste sur les missions qui la portent.
Un rapport est transmis sous forme de réponses, avec des liens vers ses photos et signatures valables une heure.
La section Brancher votre client MCP donne les éléments à reporter dans votre outil :
/api/mcpAuthorization: Bearer suivi de votre jetonsqd_… par votre jetonLa section Appeler l'API REST donne les éléments pour un outil d'automatisation :
/api/v1sqd_… par votre jetonLe lien Lire la documentation de l'API détaille les paramètres et les réponses de chaque action. Cette documentation demande d'être connecté à Squoad. Le contrat OpenAPI demande une connexion ou un jeton.
Chaque action s'appelle en POST avec un corps JSON. Le jeton se passe dans le même en-tête et donne les mêmes droits qu'avec un client MCP.
Un jeton accepte 120 appels par minute, quel que soit le mode de connexion.
Les outils qui l'utilisent perdent l'accès immédiatement.
Un jeton n'agit que dans l'établissement où il a été créé, avec les droits de la personne qui l'a créé. Il voit aussi les missions qu'une autre agence confie à cet établissement. Pour un autre établissement, créez un jeton depuis celui-ci.
Si vous êtes aussi membre de l'agence qui a confié la mission, le jeton la lit sans la modifier. Utilisez un jeton créé dans cette agence.
Seul un propriétaire révoque le jeton d'un autre membre. Un administrateur révoque les jetons qu'il a créés. Un jeton révoqué ou expiré n'a plus de menu.
Il a été révoqué ou il a expiré. Il est révoqué automatiquement quand la personne qui l'a créé quitte l'établissement ou n'est plus propriétaire ni administrateur. Il s'arrête aussi quand elle active la double authentification. Dans ces 3 cas, créez un nouveau jeton.
L'accès API suit l'abonnement de l'établissement. Il reprend dès que l'abonnement est de nouveau actif.