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 plug-in que se pueden recuperar posteriormente con la API kintone.plugin.app.proxy().

Función

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

Parámetros

PARÁMETRO TIPO OBLIGATORIO DESCRIPCIÓN
url Cuerda Sí Parte o la totalidad de la URL de la API de REST.
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: OBTENER / PUBLICAR / PONER / ELIMINAR.
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 no está definido, es nulo 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 una función de devolución de llamada, la página no navegará a la página de lista de complementos.

Respuesta

Ninguno

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, supongamos que has utilizado "kintone.plugin.app.proxy()" para ejecutar una API, con la URL https://api.example.com/rest/operate.json y un encabezado 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
  • 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 especifica una URL y un conjunto de métodos HTTP que ya se han guardado en el complemento, la nueva información lo anulará.

Condiciones para que los datos guardados se agreguen a la solicitud

La información guardada se agregará a las solicitudes que usen kintone.plugin.app.proxy() y también cumplirá con todas las condiciones siguientes:

  • Las aplicaciones son las mismas
  • Los plug-ins son los mismos
  • El método HTTP es el mismo
  • La dirección URL de la API a la que se llama forward coincide

Ejemplos de URL de coincidencia directa

Ejemplo 1

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

1
2

kintone.plugin.app.setProxyConfig()
https://api.example.com/

y se llama a la siguiente API y URL para ejecutar una API REST externa,

1
2

kintone.plugin.app.proxy()
https://api.example.com/operate.json

entonces las URL coincidirán y los datos guardados en el plug-in (guardados por kintone.plugin.app.setProxyConfig()) se añadirá a la solicitud.
Tenga en cuenta que las direcciones URL distinguen entre mayúsculas y minúsculas.

Ejemplo 2

Si ha guardado varias configuraciones en el complemento, se priorizará la URL en la configuración que coincida con la mayor cantidad de caracteres con la URL llamada por kintone.plugin.app.proxy().
Por ejemplo, digamos que usamos kintone.plugin.app.setProxyConfig() para guardar los dos ajustes siguientes en el plug-in:

1
2
3
4
5
6
7

Setting 1
URL:https://api.example.com/
Header:{"Content-Type": "application/x-www-form-urlencoded"}

Setting 2
URL:https://api.example.com/rest/
Header:{"Content-Type": "application/json"}

Si llamamos a kintone.plugin.app.proxy() para ejecutar una API REST externa con la siguiente información,

1
2

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

el encabezado de solicitud que enviará la API se convertirá:

1

{ "Content-Type": "application/json" }