Fonctions sans serveur - Types d'entrées
Table des matières
Les entrées pour la fonction peuvent être acquises dans les types suivants :
Paramètres
Les paramètres sont transmis dans l'URL de la chaîne de requête et les données dans la section post "form-data" d'une entrée. Les "params" du mappage crmAPIRequest contiennent ces paramètres, qui incluent toutes les informations transmises dans la requête.
Envoi de paramètres à l'aide de POSTMAN, dans l'URL de la demande :
Envoi de paramètres à l'aide de POSTMAN, en tant qu'objets JSON dans form-data :
Envoi de paramètres en utilisant POSTMAN, en tant que clés dans form-data :
Les paramètres mappés sur les arguments définis dans la fonction sont automatiquement synchronisés.
Pour obtenir les paramètres supplémentaires utilisés dans la demande :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir les paramètres de la demande
parameters = crmAPIRequestMap.get("params");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;
Remarque :
- Veuillez éviter d'utiliser le nom "arguments" comme argument dans la fonction. En effet, la divergence de nom pourrait entraîner le dysfonctionnement de certains arguments.
- Le mappage des arguments de la fonction se fait automatiquement lors du transfert via les paramètres, autrement dit via la chaîne de requête (de l'URL) ou les données form-data.
Flux
La section « body » de la demande peut être utilisée pour obtenir le contenu transmis à la demande sous forme de flux. La section body n'est normalement utilisée qu'avec la méthode de demande POST.
Envoi de body à l'aide de POSTMAN en tant que flux (raw) :
Envoi de body à l'aide de POSTMAN en tant que fichier binaire :
Pour obtenir l'ensemble de la section body de la demande dans une fonction :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir le contenu de la section Body de la demande
request_body = crmAPIRequestMap.get("body");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;
Dans POSTMAN, le contenu de la section body peut être transmis en mode brut ou binaire.
Remarque :
- Si les arguments de la fonction sont transmis sous forme de flux, ils ne seront pas mappés sur les arguments de la fonction.
- Si vous avez besoin de coder/décoder les données d'entrée dans la fonction, vous pouvez utiliser les tâches de chiffrement disponibles dans Deluge.
Contenu du fichier
Si le contenu de la demande est de type Multipart, il sera considéré comme un fichier. Vous pouvez obtenir le fichier dans la fonction de l'objet demande.
Les fichiers texte représentent les types de fichiers actuellement pris en charge. Pour envoyer le fichier à la fonction sous forme de données multipart, envoyez-le sous le nom d'argument "inputFile".
Pour charger le fichier à utiliser dans la fonction :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir le contenu du fichier de la demande
parameters = crmAPIRequestMap.get("file_content");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;
Remarque :
- Si l'entrée pour la fonction est indiquée sous forme de « fichier » (file), les arguments du fichier ne seront pas mappés sur ceux de la fonction.
En-têtes
L'en-tête d'une demande contient généralement des informations supplémentaires sur la demande. Les informations disponibles dans l'en-tête peuvent être acquises dans la clé "headers" de l'argument crmAPIRequest.
Pour obtenir les en-têtes de la demande :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir les informations sur l'utilisateur de la demande
header_request = crmAPIRequestMap.get("headers");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;
Informations sur l'utilisateur
Cette clé peut être utilisée pour obtenir les informations sur l'utilisateur qui invoque la fonction en utilisant la méthode OAuth2 (ainsi que sur son organisation).
Pour obtenir les informations sur les utilisateurs :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir les informations sur l'utilisateur de la demande
user_info = crmAPIRequestMap.get("user_info");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;
Remarque :
- Si la fonction est appelée en tant que clé API, les informations sur l'utilisateur que vous obtiendrez correspondront aux informations du super administrateur et non à celles de l'utilisateur qui invoque la fonction.
Type d'authentification et méthode
Ces 2 clés peuvent être utilisées pour obtenir les informations d'authentification (apikey ou oauth) et la méthode HTTP (GET/POST).
Pour obtenir des informations sur le type d'authentification :
crmAPIRequestMap = crmAPIRequest.toMap();
// pour obtenir la méthode HTTP de la demande
user_info = crmAPIRequestMap.get("method");
// pour obtenir le type d'authentification de la demande
user_info = crmAPIRequestMap.get("auth_type");
/**
Votre logique métier ici
**/
return crmAPIRequestMap;