Documentos de API

Proxy Get Config

Proxy Get Config - kintone.plugin.app.getProxyConfig()

Recupera los encabezados y los datos que se agregarán a la solicitud al ejecutar una API web externa con la siguiente API.
Solicitud de proxy de complemento

Esta información primero deberá guardarse mediante la siguiente API.
Configuración del conjunto de proxy (Proxy Set Config)

Función

kintone.plugin.app.getProxyConfig(url, method)

Parámetros

PARÁMETRO TIPO OBLIGATORIO DESCRIPCIÓN
url Cuerda Sí La dirección URL de la API que se va a ejecutar.
method Cuerda Sí El método HTTP. Especifique una de las siguientes opciones: GET / POST / PUT / DELETE.

Devuelve

Un JSON que contiene encabezados y datos para la solicitud necesaria para ejecutar la API web externa.

PARÁMETRO TIPO DESCRIPCIÓN
headers Object Encabezado de solicitud especificado como headers en Proxy Set Config API.
data Object Cuerpo de la solicitud especificado como data en Proxy Set Config API.
  • Se devuelve null para las páginas en las que no se puede usar.
  • null se devuelve, si no hay ningún ajuste de configuración establecido por Proxy Set Config API que coincide.

Páginas disponibles

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

  • Configuración del plug-in

Muestra

Ejemplo de uso de esta API para recuperar valores guardados:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10

const headers = {
  Authorization: 'Bearer TEST_TOKEN',
};
const data = {
  key1: '1',
  key2: true
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, data);
const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST');
console.log(config);

Notas

Al utilizar esta API para recuperar el valor especificado para headers en Proxy Set Config API, el valor siempre será una cadena.

Por ejemplo, cuando se asignan valores enteros o booleanos a la propiedad headers:

1
2
3
4
5

const headers = {
  key1: 1,
  key2: true,
};
kintone.plugin.app.setProxyConfig('https://api.example.com', 'POST', headers, {}, () => console.log('Saved!'));

En este caso, cuando se ejecuta la siguiente API, los valores de los tipos enteros o booleanos se devuelven como tipos de cadena:

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14

const config = kintone.plugin.app.getProxyConfig('https://api.example.com', 'POST');
console.log(config);
// response

/**
 * 1 and true are returned as string types
 * {
 *    headers: {
 *      "key1": "1", // string
 *      "key2": "true",  // string
 *    },
 *    data: {},
 *  }
 **/