Obtenir un scénario avec l'API Make
Renvoie les détails d'un scénario, comme son nom, son équipe, sa planification et s'il est actif.
- Identifiant
- make_get_scenario
L'appel
POST https://connect.reportei.com/api/tools/make_get_scenario/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"scenarioId": 1
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| scenarioId | integer | Oui | Id of the scenario, from List scenarios. |
Connexions possibles
Votre client connecte son compte Make une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Clé d'API
Votre client colle la clé de l'app sur un écran de Connect, ou votre système envoie la clé avec POST /api/customer-toolkits, sans écran.
À la connexion, votre client indique aussi {zone} : l'adresse de son compte sur l'API de l'app.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/make_get_scenario. Il devient la définition de tool de votre agent sans conversion.
Autres tools Make
- Lister les organisationsGETListe les organisations de l'utilisateur, chacune avec id et name. L'id est l'organizationId que demandent les autres outils.
- Lister les équipesGETListe les équipes d'une organisation, chacune avec id et name. L'id est le teamId de List scenarios.
- Lister les scénariosGETListe les scénarios d'une équipe ou de toute une organisation : envoyez teamId ou organizationId, jamais les deux. Chaque élément contient l'id et le name du scénario.
- Mettre à jour un scénarioPATCHRenomme un scénario. Le nom n'a pas besoin d'être unique.
- Activer un scénarioPOSTActive un scénario pour qu'il s'exécute selon sa planification. Un scénario planifié à intervalles réguliers s'exécute aussi tout de suite.
- Désactiver un scénarioPOSTDésactive un scénario, ce qui arrête sa planification et l'exécution en cours, s'il y en a une.
- Exécuter un scénarioPOSTExécute un scénario actif maintenant, ce qui consomme des opérations de l'organisation. Renvoie l'executionId ; avec responsive true il attend jusqu'à 40 secondes et renvoie aussi le statut et les sorties du scénario. Une organisation ou équipe en pause répond 429 avec le code IM310.
- Lister les journaux d'un scénarioGETListe les journaux d'exécution d'un scénario, du plus récent au plus ancien, chacun avec l'id de l'exécution, le statut, la durée, les opérations et le transfert.
Voyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
