Solicitud de proxy de complemento
Solicitud de proxy de complemento: kintone.plugin.app.proxy()
Ejecuta una API REST externa desde un complemento.
Si tu API de REST externa requiere información confidencial, como claves secretas, usa la API Set Config for proxy() y Get Config for proxy() que se mencionan más adelante, para guardar y obtener estos datos para la API de REST externa.
Función
kintone.plugin.app.proxy(pluginId, url, method, headers, data, successCallback, failureCallback)
Parámetros
PARÁMETRO | TIPO | OBLIGATORIO | DESCRIPCIÓN |
---|---|---|---|
pluginId | Cuerda | Sí | El ID del complemento que ejecutará la API. |
URL | Cuerda | Sí | La dirección URL de la API de REST que ejecutará. |
method | Cuerda | Sí | El método HTTP. Especifique una de las siguientes opciones: OBTENER / PUBLICAR / PONER / ELIMINAR. |
headers | Objeto | Sí | El encabezado de la solicitud. Los parámetros especificados aquí se enviarán con los parámetros que fueron guardados en el plug-in por el kintone.plugin.app.setProxyConfig() función. |
data | Objeto o cadena | Sí | Los datos de la solicitud. Para ignorar este parámetro, ingrese {} .Los datos especificados aquí se enviarán con los datos que se guardaron en el complemento por el kintone.plugin.app.setProxyConfig() función.Se aplica solo para solicitudes POST/PUT. Se omite para las solicitudes GET/DELETE. En el caso de las solicitudes GET/DELETE, establezca el parámetro en QueryString de la dirección URL en su lugar. |
successCallback | Función | Opcional | La función que se ejecutará una vez finalizada la solicitud. Los siguientes tres datos se pasarán como parámetros:
|
failureCallback | Función | Opcional | La función que se ejecutará cuando se produzca un error en la solicitud. El cuerpo de la respuesta se pasará al parámetro de función como una cadena. Si se ignora la devolución de llamada, un kintone. Se devolverá un objeto de promesa que se puede cumplir con el cuerpo de respuesta (cadena) de la API de proxy del complemento de Kintone. |
Respuesta
Un kintone.Promise
object se devolverá si el objeto successCallback
o failureCallback
se ignoran los parámetros. De lo contrario, no habrá respuesta.
Páginas disponibles
Este método se puede utilizar en las siguientes páginas:
Páginas de escritorio:
- Lista de registros
- Detalles del registro
- Creación de registros
- Grabar Editar
- Gráfico
- Impresión
Páginas móviles:
- Lista de registros
- Detalles del registro
- Creación de registros
- Grabar Editar
- Gráfico
Solicitud de muestra
|
|
Solicitud de ejemplo mediante promesas
|
|
Notas
- Si el dominio de origen de la solicitud tiene restricciones de IP e intenta acceder a otra aplicación en el mismo dominio, se puede permitir que las direcciones IP de kintone.com otorguen acceso al complemento. Puede encontrar una lista de direcciones IP utilizadas por Kintone en el siguiente artículo del sitio de ayuda:
Dominios y direcciones IP utilizados por Kintone - Tenga en cuenta que esto permite que cualquier dominio kintone.com acceda a la API y, por lo tanto, no se recomienda desde el punto de vista de la seguridad.
- Cuando utilice la API de REST de Kintone en su propio dominio de Kintone, utilice la solicitud de API de REST de Kintone en lugar de la
kintone.proxy()
API. Para obtener más información sobre la solicitud de API REST de Kintone, consulte el siguiente artículo:
Solicitud de API REST de Kintone
Limitaciones
- Especificación de un valor inexistente
url
devolverá un código de estado de error de503 (DNS Cache Missing)
. - Esta API solo puede manejar un cuerpo de caracteres de respuesta. No se admiten imágenes u otros datos binarios.
- El
Content-Length
encabezado yTransfer-Encoding
los encabezados se agregan automáticamente si el método HTTP se establece enPOST
oPUT
. - Configuración explícita
headers
provocará un error.