Documentos de API

Configuración del conjunto de proxy

Configuración del conjunto de proxy: kintone.plugin.app.setProxyConfig()

Guarda los ajustes de configuración del complemento necesarios para ejecutar una API web externa en un complemento.
Cuando se ejecuta la siguiente API, la información guardada con esta API se agrega al encabezado y al cuerpo de la solicitud.
Solicitud de proxy de complemento

Esta API solo se puede ejecutar en la página de configuración del complemento, a la que solo puede acceder el administrador de la aplicación. Esto evita que los usuarios no administradores accedan a la información guardada en el complemento.

Función

kintone.plugin.app.setProxyConfig(url, method, headers, data, successCallback)

Parámetros

PARÁMETRO TIPO OBLIGATORIO DESCRIPCIÓN
url Cuerda Sí La dirección URL de la API que se va a ejecutar.
Consulte la siguiente sección para conocer las condiciones de los datos que se agregarán a la solicitud de API:
Condiciones para que los datos guardados se agreguen a la solicitud
method Cuerda Sí El método HTTP. Especifique una de las siguientes opciones: GET / POST / PUT / DELETE.
headers Objeto Sí Los parámetros que se agregarán al encabezado de solicitud de la API.
Si los nombres de los parámetros se superponen con los parámetros especificados con kintone.plugin.app.proxy(), entonces los parámetros especificados aquí tendrán prioridad. Para obtener más información, consulte el siguiente artículo:
Solicitud de proxy de complemento
Deje esto como {} si los parámetros no son necesarios.
data Objeto Sí Especifique los datos que se agregarán a los datos de solicitud de API, como un objeto con un conjunto de claves y valores en su interior.
Ejemplo:
{
  "key1": "value1",
  "key2": "value2"
}
Si los nombres de clave se superponen con las claves especificadas con kintone.plugin.app.proxy() y, a continuación, los valores de propiedad especificados aquí tendrán prioridad. Para obtener más información, consulte el siguiente artículo:
Solicitud de proxy de complemento
Deje esto como {} si no se necesitan llaves.
Los valores de tipo de objeto no se pueden especificar como valores de propiedad.
successCallback Función Opcional La función a la que se llamará después de que los ajustes se hayan guardado correctamente. No hay parámetros. Si esto está undefined, es null o no se especifica, la página navegará a la página de lista de complementos y mostrará un mensaje que indica que la configuración ha finalizado.
Si se especifica successCallback, la página no navegará a la página de lista de complementos.

Devuelve

Nada

Páginas disponibles

Este método se puede utilizar en las siguientes páginas:

  • Configuración del plug-in

Muestra 

1
2
3
4
5
6
7
8

var headers = {
  'Content-Type': 'application/json',
  'Authorization': '777-777-abcded-ghijkl'
};
var data = {
  'key1': 'secretValue'
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'GET', headers, data);

Una vez que se hayan guardado los ajustes anteriores, el kintone.plugin.app.proxy() La API se puede ejecutar con la URL https://api.example.com/rest/operate.json y un encabezado vacío de {}.
En este caso, el encabezado de la solicitud que se enviará será:

1

{ "Content-Type": "application/json", "Authorization": "777-777-abcded-ghijkl" }

Formato guardado

Los datos guardados por esta API se guardarán en el siguiente formato:

  • URL
  • El método HTTP (GET / POST / PUT / DELETE)
  • Datos guardados
  • Un objeto se guardará con un conjunto de claves y valores que incluyen lo siguiente:
    • Encabezado de solicitud
    • Solicitar datos

Si se especifica una URL y un conjunto de métodos HTTP que ya se han guardado en el complemento, la nueva información anulará los datos existentes.

Condiciones para que los datos guardados se agreguen a la solicitud

Al utilizar kintone.plugin.app.proxy(), la información guardada en los ajustes de configuración del plug-in se puede añadir automáticamente a la solicitud cuando se cumplen todas las condiciones siguientes:

  • Las aplicaciones son las mismas
  • Los plug-ins son los mismos
  • El método HTTP es el mismo
  • La URL de la API llamada matches (coincidencia directa, distingue entre mayúsculas y minúsculas).

Por ejemplo, la siguiente API y URL se utilizan para guardar la configuración en el complemento.

  • URL especificada mediante **Proxy Get Config** API: https://api.example.com/

A continuación, se llama a la siguiente API y URL para ejecutar una API web externa.

  • URL especificada mediante **Plug-in Proxy Request* API: https://api.example.com/operate.json

La información guardada en el complemento se agregará a la solicitud porque la URL coincide con el comienzo de la URL.

Prioridad para múltiples ajustes de configuración

Si se guardan varias configuraciones en el complemento, la URL de la configuración que coincida con la mayoría de los caracteres con la URL llamada por kintone.plugin.app.proxy() se dará prioridad.
Por ejemplo, el **Proxy Set Config* La API se utiliza para guardar las dos configuraciones siguientes en el complemento:

  • Ajuste 1
    • URL: https://api.example.com/
    • Header: { "Content-Type": "application/x-www-form-urlencoded" }
  • Ajuste 2
    • URL: https://api.example.com/foo/
    • Header: { "Content-Type": "application/json" }

Entonces kintone.plugin.app.proxy() se llama para ejecutar una API web externa con la siguiente información:

  • URL: https://api.example.com/foo/operate.json
  • Header: {}

El encabezado de la solicitud que se envía cuando se ejecuta la API es { "Content-Type": "application/json" }.