Précontrôler le fichier d'importation de Workflow

Permet de vérifier au préalable si un fichier .flow peut être importé, sans écrire de ressources métier.

Cette interface permet de vérifier au préalable si un fichier .flow peut être importé. La pré-vérification se limite à l'analyse et à l'analyse de sécurité du fichier ; elle n'écrit ni Workflow, ni API Key, ni groupes de données, ni relations de plugins.

Méthode de requête

POST

URL de la requête

https://api.${endpoint}/v1/org/workflow/import/precheck

Authentification de la requête

Utilise l'authentification Basic avec la DevKey / le DevSecret de niveau compte et requiert que le compte appelant dispose de l'autorisation de création de Workflow de l'organisation.

Requête

Exemple de requête

curl -X POST 'https://api.${endpoint}/v1/org/workflow/import/precheck' \ -H 'Authorization: Basic ${BASIC_TOKEN}' \ -F 'file=@/path/to/workflow.flow' \ -F 'org_id=p-xxxx'

                      
                      curl -X POST 'https://api.${endpoint}/v1/org/workflow/import/precheck' \
  -H 'Authorization: Basic ${BASIC_TOKEN}' \
  -F 'file=@/path/to/workflow.flow' \
  -F 'org_id=p-xxxx'

Ce bloc de code dans la fenêtre flottante

En-têtes de la requête

Champ	Type	Description
Authorization	Basic ${BASIC_TOKEN}	Utilisez le Basic Token obtenu en encodant `DevKey:DevSecret` en Base64.
Content-Type	multipart/form-data	Formulaire de téléversement de fichier.

Paramètres de la requête (Form Data)

Champ	Type	Description	required
file	File	Fichier `.flow`.	true
org_id	String	ID de l'organisation.	true

Réponse

Exemple de réponse

{ "code": 0, "message": "OK", "data": { "valid": true, "error_message": null, "export_type": "WORKFLOW", "bot_type": "WORKFLOW", "name": "Imported Workflow", "logo": "https://cdn.example.com/workflow.png", "introduction": "Workflow introduction", "format_version": "1.0" } }

                      
                      {
  "code": 0,
  "message": "OK",
  "data": {
    "valid": true,
    "error_message": null,
    "export_type": "WORKFLOW",
    "bot_type": "WORKFLOW",
    "name": "Imported Workflow",
    "logo": "https://cdn.example.com/workflow.png",
    "introduction": "Workflow introduction",
    "format_version": "1.0"
  }
}

Ce bloc de code dans la fenêtre flottante

Réponse en cas de succès

Champ	Type	Description
valid	Boolean	Indique si le fichier peut être importé.
error_message	String	Message d'erreur si l'importation est impossible.
export_type	String	Type de fichier exporté.
bot_type	String	Type de Bot.
name	String	Nom de la ressource dans le fichier.
logo	String	URL de l'icône.
introduction	String	Présentation.
format_version	String	Version du format de fichier.

Réponse en cas d'échec

Champ	Type	Description
code	Integer	Code d'erreur.
message	String	Détails de l'erreur.

Codes d'état

Code d'état	Description
200	Succès
400	Erreur de paramètre
401	Non autorisé
403	Autorisation insuffisante
429	Requêtes trop fréquentes
500	Erreur du serveur