Funciones sin servidor - Tipos de entradas
Tabla de contenido
La entrada de la función puede obtenerse de las siguientes formas:
Parámetros
Se pasan en la dirección URL de la cadena de consulta y en los datos que se pasan en la sección de datos del formulario de publicación de una entrada. Los "params" del mapa crmAPIRequest contienen esto parámetros que tienen toda la información que se pasa en la solicitud.
Enviar parámetros utilizando POSTMAN dentro de la dirección URL de la solicitud:
Enviar parámetros utilizando POSTMAN como objetos JSON en datos de formulario:
Enviar parámetros utilizando POSTMAN como claves de datos de formulario:
Los parámetros que asignan los argumentos definidos en la función, se sincronizarán automáticamente.
Para obtener los parámetros adicionales que se utilizan en la solicitud:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the parameters of the request
parameters = crmAPIRequestMap.get("params");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;
Nota:
- Evite utilizar el nombre "arguments" como argumento dentro de la función, ya que la desigualdad de nombres podría llevar a que algunos argumentos no funcionen.
- La asignación de los argumentos de la función se realiza automáticamente cuando se pasan a través de los "parámetros", es decir, cuando se pasan a través de la cadena de consulta (de la dirección URL) o de los datos de formulario.
Secuencia
El "cuerpo" de la solicitud se puede utilizar para obtener contenido que se pasa como una secuencia a la solicitud. Normalmente, el cuerpo solo se utiliza cuando el método de la solicitud es POST.
Enviar el cuerpo mediante POSTMAN como una secuencia (sin procesar):
Enviar el cuerpo mediante POSTMAN como un archivo binario:
Para obtener toda la sección del cuerpo de la solicitud en una función:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the Body content of the request
request_body = crmAPIRequestMap.get("body");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;
En POSTMAN, el contenido del cuerpo se puede pasar en forma sin procesar o binaria.
Nota:
- Si los argumentos de la función se pasan a través de la secuencia, no se asignan a los argumentos de la función.
- En caso de que necesite codificar o descodificar los datos ingresados en una función, puede usar las tareas de cifrado disponibles en Deluge.
Contenido de los archivos
Si el tipo de contenido de la solicitud es "multiparte", se lo considerará como un archivo. Puede obtener el archivo dentro de la función en el objeto de la solicitud.
Los tipos de archivo admitidos actualmente son los archivos de texto. A fin de enviar el archivo a la función como datos multiparte, envíelo con el nombre de argumento "inputFile".
Para que el archivo cargado se utilice en la función:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the File content of the request
parameters = crmAPIRequestMap.get("file_content");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;
Nota:
- Si la información ingresada para la función se brinda en forma de "archivo", los argumentos del archivo no se asignarán a los argumentos de la función.
Encabezados
El encabezado de una solicitud normalmente contiene información adicional acerca de esta. La información que está disponible en el encabezado se puede adquirir en la clave "headers" dentro del argumento crmAPIRequest.
Para obtener los encabezados de la solicitud:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the user info of the request
header_request = crmAPIRequestMap.get("headers");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;
Información del usuario
Esta clave se puede utilizar para obtener la información sobre el usuario que invoca la función usando el método OAuth2, así como sobre su organización.
Para obtener información acerca de los usuarios:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the user info of the request
user_info = crmAPIRequestMap.get("user_info");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;
Nota:
- Si se llama a la función como la clave de API, la información que obtendrá sobre el usuario será información acerca del superadministrador y no sobre el usuario que invocó la función.
Tipo y método de autenticación
Estas dos claves se pueden utilizar para obtener la información de autenticación (apikey o oauth) y el método HTTP (GET/POST).
Para obtener información sobre el tipo de autenticación:
crmAPIRequestMap = crmAPIRequest.toMap();
// to get the HTTP method of the request
user_info = crmAPIRequestMap.get("method");
// to get the authentication type of the request
user_info = crmAPIRequestMap.get("auth_type");
/**
Su lógica empresarial aquí
**/
return crmAPIRequestMap;